Create a Sales Order

post

https://openapi.staging.tryware2go.com/v1/merchants/{merchantId}/orders

Creates and submits a new outbound order. Requires a valid order object in the request body. Do not include the 'orderId' attribute as the 'orderId' is generated after creating an order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

merchantId

string

required

The merchant ID assigned by Ware2Go.

Body Params

referenceId

string

required

length between 1 and 30

The ID provided by the user. Must only contain alphanumeric characters or the following special characters: .-_()

purchaseOrderNumber

string

Used for referencing a related Purchase Order Number. Note that you can associate the same PO # with different Reference IDs.

isMerchantManaged

boolean

Used to indicate whether or not a Freight Shipment will be handled by a Carrier of your choosing. Please note that if you include this field and flag it as “Yes” you are responsible for providing W2G with a copy of the associated BOL which will be provided to the Warehouse.

customerId

string

Used for Retail Compliance purposes.

skuQuantities

array of objects

required

An array of items included on the order.

skuQuantities*

warehouseFacility

object

Used to assign an order to a specific Warehouse. If you do not provide a Warehouse for the outbound order, the platform will select a warehouse facility based upon a combination of the destination address and inventory availability. Note that use of this field bypasses all W2G allocation and Backorder logic.

priority

string

enum

Used to drive the sequence in which orders are Waved at the Warehouse.

Allowed:

companyName

string

required

length ≤ 250

Used to indiciate the recipient of the order.

phoneNumber

string

length ≤ 25

Required for international orders, orders to US territories, and freight orders.

buyerEmail

string

length ≤ 100

The contact email address at the company receiving the order. When provided, W2G will send updates about the order via email. W2G supports at most one email address.

attnTo

string

length ≤ 30

The “Attention To” line of the shipping address

address1

string

required

length ≤ 45

If you are shipping to a PO BOX Address, you must include the “PO Box” portion of the Address on Line 1.

address2

string

length ≤ 45

The second line of the shipping address, if applicable.

city

string

required

length ≤ 45

The city portion of the shipping address.

state

string

required

length ≤ 2

The two-character state code for the state portion of the shipping address, e.g. GA or TN.

zipCode

string

required

length between 5 and 9

The zip code portion of the shipping address.

country

string

required

≤ 3

ISO 3166-1 alpha-2 Country Codes should be used (e.g. “US” for all Domestic orders.

shippingSpeed

string

enum

Defaults to TWO_DAY

Used to indicate the UPS Shipping Service that you would like to use for the order. If a Shipping Speed is not provided, the order will default to TWO_DAY.

duties

string

enum

UNPAID means tax and duties are unpaid and end customer is responsible for paying this. PREPAID indicates that the seller must cover duties, import clearance, and any taxes.

Allowed:

customerOrderType

string

enum

A conditional field that is required when creating Work Orders and/or FBA orders. Must be FBA when creating an FBA order, and must be WO when creating a Work Order. Can be used to create SFP orders

Allowed:

workOrderType

string

enum

This field can be NULL if the customerOrderType field is NOT WO. If an Address other than the Warehouse Address is entered and workOrderType is OTHER or KIT_TO_STOCK, we override the provided Address and send the Warehouse Address in the order. Work Orders flagged as KTS must only include KTS SKUS. Work Orders flagged as OTHER can include any SKU Type except for KTO.

Allowed:

status

string

enum

This field should be ignored. It will be removed in an upcoming release.

packages

array of objects

This Array of Objects should be ignored. It will be removed in an upcoming release.

packages

insuredValue

number

The value of the shipment for insurance purposes.

tmsInfo

object

An array of objects that defines additional services included with the order.

thirdPartyAccountNumber

string

Required when billing orders against a 3rd Party UPS Account. Used to capture the UPS Account Number against which the order is to be billed. Note, orders billed against a 3rd Party Account Number incur a flat fee, please discuss with your Sales Representative.

salesChannelOrderInfo

object

Used to provide detail around the Sales Channel from which an order originated.

billToName

string

Required if thirdPartyAccountNumber is present. Used to indicate the Billing Name associated with the 3rd Party UPS Account Number.

billToAddress1

string

length ≤ 35

Required if thirdPartyAccountNumber is present. Used to indicate the first Address Line of the Billing Address associated with the 3rd Party UPS Account Number.

billToAddress2

string

length ≤ 30

Used to indicate the second Address Line of the Billing Address associated with the 3rd Party UPS Account Number.

billToCity

string

Required if thirdPartyAccountNumber is present. Used to indicate the City of the Billing Address associated with the 3rd Party UPS Account Number.

billToState

string

Required if thirdPartyAccountNumber is present. Used to indicate the State of the Billing Address associated with the 3rd Party UPS Account Number.

billToZipCode

string

length between 5 and 9

Required if thirdPartyAccountNumber is present. Used to indicate the Zip Code of the Billing Address associated with the 3rd Party UPS Account Number.

billToCountry

string

Required if thirdPartyAccountNumber is present. Should always be “US”.

billToEmail

string

An email address for the point of contact at the third party billing organization. Only used if thirdPartyAccountNumber is present.

billToPhoneNumber

string | null

A phone number for the point of contact at the third party billing organization. Ware2Go will check the string for optional digits, dashes, or parenthesis, and will replace them with dashes and spaces. W2G will also perform checks for international phone numbers. Only used if thirdPartyAccountNumber is present.

sfpBrand

string

Used to associate a specific brand with a specific SFP order. This is relevant if you are fulfilling orders for multiple Amazon Storefronts through a single Merchant account in FulfillmentVu.

fbaPartnered

boolean | null

A flag to indicate FBA order should be shipped using Amazon partner settings.

notes

string

length ≤ 255

Used to pass a Note which will appear on the Packing Slip.

errors

array of objects

This field should be ignored. It will be removed in an upcoming release.

errors

linkedASN

string

The ASN number associated with inbounding the inventory needed for the associated FBA order. Can only be used when customerOrderType is set to FBA.

linkedOutboundWorkOrder

string

The outbound work order number associated with the work order to prepare the inventory for the associated FBA order. Can only be used when customerOrderType is set to FBA.

routing

object

Used to determine the carrier routing of the order. Only one of carrier/serviceLevel, stordServiceLevel, or maxBusinessDaysInTransit allowed.

replacesOrder

object

Reference to the previous outbound order that precedes this new order being created.

orderSummary

object

An object that defines the value and payment status of the order.

orderTags

array of strings

An optional array of tags associated with the order.

orderTags

Responses

200OK

400Bad request - malformed, missing parameters, etc.

401Unauthorized - incorrect security information

403Forbidden - access disallowed

404Not Found - unable to find resource

429Too Many Requests - sent too many requests in a given amount of time

500Internal server error - unknown error