Create an Inbound Shipment

post

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

Creates a new Inbound Shipment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

merchantId

string

required

The merchant ID assigned by Ware2Go.

Body Params

shipmentId

string

length ≤ 30

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

referenceId

string

required

length ≤ 30

A unique identifier for the ASN. You cannot reuse Reference IDs, if an ASN is canceled and you attempt to create a new ASN with the same Reference ID, you will receive an error response. Only alphanumeric characters or the following special characters are supported: .-_()

shipmentName

string

length ≤ 255

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

carrier

string

length ≤ 255

Carrier Short Code (i.e. “UPS” for United Parcel Service), enter UPS if small parcel or if it's Freight, provide a Short Code for your Freight Carrier.

destinationFacility

object

required

An object defining the warehouse that will receive the shipment.

estimatedDeliveryDate

date

required

The estimated date that the shipment will be delivered. Use 'CCYY-MM-DD' or 'CCYY-MM-DDThh:mm:ss+offset' formats.

estimatedShipDate

date

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

companyName

string

length ≤ 250

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

address1

string

length ≤ 45

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

address2

string

length ≤ 45

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

address3

string

length ≤ 45

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

city

string

length ≤ 30

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

state

string

length ≤ 2

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

zipCode

string

length between 5 and 5

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

country

string

≤ 3

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

notes

string | null

An optional field used to associate a Note with an ASN.

status

string

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

items

array of objects

An array of objects that define the items included on the shipment.

items

pallets

array of objects

An array defining the pallets made up for the shipment.

pallets

errors

array of objects

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

errors

containerNumber

string

length ≤ 30

The number of the container in which the shipment is being transported. This may include alphanumeric characters, spaces, and the following special characters: -_

trackingNumbers

array of strings

Carrier tracking number for each SKU in the order. You can enter multiple tracking IDs for a single ASN.

trackingNumbers

asnTags

array of strings

An array of tags to be associated with the shipment.

asnTags

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