Get Started
Common Features
Inventory API v1
Receiving API v1
Shipping API v1
System API v1
curl --request GET \
--url https://{base_url_domain}/api/global/v1/receiving/{type} \
--header 'Authorization: Bearer <token>'{
"collection": [
{
"type": "ASN",
"warehouse": {
"type": "Warehouse",
"id": 123
},
"id": 123,
"supplier_name": "<string>",
"expected_at": "2019-12-03T21:06:26Z",
"merchant_reference": "<string>",
"supplier_invoice_reference": "<string>",
"supplier_order_reference": "<string>",
"shipment_type": "international_maritime_freight",
"bill_of_lading": "<string>",
"standard_carrier_alpha_code": "<string>",
"merchant": {
"type": "Merchant",
"id": 4
},
"increment_id": "11000020",
"state": "new",
"status": "new",
"progress_percent": 50,
"carrier_name": "<string>",
"delivered_at": "2019-12-03T21:06:26Z",
"receive_by": "2019-12-03T21:06:26Z",
"processed_at": "2019-12-03T21:06:26Z",
"putaway_at": "2019-12-03T21:06:26Z",
"completed_at": "2019-12-03T21:06:26Z",
"ready_to_process_at": "2019-12-03T21:06:26Z",
"merchant_status": "<string>",
"item_count": 123,
"container_count": 123,
"label_count": 123,
"exception_count": 123,
"processing_comments": "<string>",
"special_requirements": [
"<string>"
],
"is_auto_commit": true,
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z",
"tracking_numbers": [
{
"type": "DeliveryTrackingNumber",
"id": 123,
"tracking_number": "<string>"
}
],
"status_history": [
{
"delivery_item": {
"type": "DeliveryItem",
"id": 3,
"delivery": {
"type": "ASN",
"id": 3
},
"qty": 123,
"qty_expected": 123,
"qty_received": 123,
"qty_shortage": 123,
"qty_overage": 123,
"qty_processed": 123,
"qty_putaway": 123,
"qty_committed": 123,
"qty_returned": 123,
"is_sku_merge_email_sent": true,
"lots": [
{
"type": "DeliveryItemLot",
"id": 3,
"lot": {
"type": "Lot",
"id": 54
},
"qty_counted": 123,
"qty_putaway": 123
}
],
"locations": [
{
"type": "DeliveryItemLocation",
"id": 3,
"location": {
"type": "Location",
"id": 42
},
"qty_putaway": 123,
"qty_committed": 123
}
],
"exceptions": [
{
"type": "DeliveryItemException",
"id": 3,
"delivery_item": {
"type": "DeliveryItem",
"id": 123
},
"container": {
"type": "DeliveryContainer",
"id": 3,
"container_type": {
"type": "DeliveryContainerType",
"id": 3,
"merchant": {
"type": "Merchant",
"id": 4
},
"delivery_type": "asn",
"name": "<string>",
"name_plural": "<string>",
"weight": {
"value": 20,
"unit": "lb"
},
"is_default": true,
"is_system": true
},
"damage_type": "none",
"weight_discrepancy_reason": "none",
"tare_weight": {
"value": 20,
"unit": "lb"
},
"weight": {
"value": 20,
"unit": "lb"
},
"weighed_at": "2019-12-03T21:06:26Z",
"weighed_by": {
"type": "OrganizationUser",
"id": 3
},
"contents": [
{
"delivery_item": {
"type": "DeliveryItem",
"id": 123
},
"qty_counted": 123,
"qty_shortage": 123,
"qty_counted_per_lot": [
{
"lot": {
"type": "Lot",
"id": 54
},
"quantity": 123
}
]
}
],
"condition_note": "<string>",
"item_count": 123
},
"lot": {
"type": "Lot",
"id": 54
},
"status": "new",
"sign": 1,
"reason": "<string>",
"comment": "<string>",
"qty": 123
}
]
},
"status": "new",
"exception": {
"type": "Exception",
"id": 123
},
"exception_status": "new",
"comment": "<string>",
"user": {
"type": "OrganizationUser",
"id": 3
},
"created_at": "2017-07-21T17:32:28Z",
"package": {
"type": "Package",
"id": 123
}
}
]
}
],
"included": {
"Merchant": [
{
"type": "Merchant",
"id": 4,
"code": "acme_inc",
"name": "ACME Inc.",
"status": "active",
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z",
"brands": [
{
"type": "Brand",
"id": 4
}
],
"default_brand": {
"type": "Brand",
"id": 4
}
}
],
"Warehouse": [
{
"type": "Warehouse",
"id": 3,
"name": "East Coast 1",
"is_active": true
}
]
},
"has_more": true,
"next": "<string>",
"previous": "<string>",
"meta": {
"processing_time": 0.2525252525,
"cursor_start": 123,
"cursor_end": 123,
"count": 123
}
}List all Deliveries
Returns a list of ASN or RMA objects specified by the type path parameter.
curl --request GET \
--url https://{base_url_domain}/api/global/v1/receiving/{type} \
--header 'Authorization: Bearer <token>'{
"collection": [
{
"type": "ASN",
"warehouse": {
"type": "Warehouse",
"id": 123
},
"id": 123,
"supplier_name": "<string>",
"expected_at": "2019-12-03T21:06:26Z",
"merchant_reference": "<string>",
"supplier_invoice_reference": "<string>",
"supplier_order_reference": "<string>",
"shipment_type": "international_maritime_freight",
"bill_of_lading": "<string>",
"standard_carrier_alpha_code": "<string>",
"merchant": {
"type": "Merchant",
"id": 4
},
"increment_id": "11000020",
"state": "new",
"status": "new",
"progress_percent": 50,
"carrier_name": "<string>",
"delivered_at": "2019-12-03T21:06:26Z",
"receive_by": "2019-12-03T21:06:26Z",
"processed_at": "2019-12-03T21:06:26Z",
"putaway_at": "2019-12-03T21:06:26Z",
"completed_at": "2019-12-03T21:06:26Z",
"ready_to_process_at": "2019-12-03T21:06:26Z",
"merchant_status": "<string>",
"item_count": 123,
"container_count": 123,
"label_count": 123,
"exception_count": 123,
"processing_comments": "<string>",
"special_requirements": [
"<string>"
],
"is_auto_commit": true,
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z",
"tracking_numbers": [
{
"type": "DeliveryTrackingNumber",
"id": 123,
"tracking_number": "<string>"
}
],
"status_history": [
{
"delivery_item": {
"type": "DeliveryItem",
"id": 3,
"delivery": {
"type": "ASN",
"id": 3
},
"qty": 123,
"qty_expected": 123,
"qty_received": 123,
"qty_shortage": 123,
"qty_overage": 123,
"qty_processed": 123,
"qty_putaway": 123,
"qty_committed": 123,
"qty_returned": 123,
"is_sku_merge_email_sent": true,
"lots": [
{
"type": "DeliveryItemLot",
"id": 3,
"lot": {
"type": "Lot",
"id": 54
},
"qty_counted": 123,
"qty_putaway": 123
}
],
"locations": [
{
"type": "DeliveryItemLocation",
"id": 3,
"location": {
"type": "Location",
"id": 42
},
"qty_putaway": 123,
"qty_committed": 123
}
],
"exceptions": [
{
"type": "DeliveryItemException",
"id": 3,
"delivery_item": {
"type": "DeliveryItem",
"id": 123
},
"container": {
"type": "DeliveryContainer",
"id": 3,
"container_type": {
"type": "DeliveryContainerType",
"id": 3,
"merchant": {
"type": "Merchant",
"id": 4
},
"delivery_type": "asn",
"name": "<string>",
"name_plural": "<string>",
"weight": {
"value": 20,
"unit": "lb"
},
"is_default": true,
"is_system": true
},
"damage_type": "none",
"weight_discrepancy_reason": "none",
"tare_weight": {
"value": 20,
"unit": "lb"
},
"weight": {
"value": 20,
"unit": "lb"
},
"weighed_at": "2019-12-03T21:06:26Z",
"weighed_by": {
"type": "OrganizationUser",
"id": 3
},
"contents": [
{
"delivery_item": {
"type": "DeliveryItem",
"id": 123
},
"qty_counted": 123,
"qty_shortage": 123,
"qty_counted_per_lot": [
{
"lot": {
"type": "Lot",
"id": 54
},
"quantity": 123
}
]
}
],
"condition_note": "<string>",
"item_count": 123
},
"lot": {
"type": "Lot",
"id": 54
},
"status": "new",
"sign": 1,
"reason": "<string>",
"comment": "<string>",
"qty": 123
}
]
},
"status": "new",
"exception": {
"type": "Exception",
"id": 123
},
"exception_status": "new",
"comment": "<string>",
"user": {
"type": "OrganizationUser",
"id": 3
},
"created_at": "2017-07-21T17:32:28Z",
"package": {
"type": "Package",
"id": 123
}
}
]
}
],
"included": {
"Merchant": [
{
"type": "Merchant",
"id": 4,
"code": "acme_inc",
"name": "ACME Inc.",
"status": "active",
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z",
"brands": [
{
"type": "Brand",
"id": 4
}
],
"default_brand": {
"type": "Brand",
"id": 4
}
}
],
"Warehouse": [
{
"type": "Warehouse",
"id": 3,
"name": "East Coast 1",
"is_active": true
}
]
},
"has_more": true,
"next": "<string>",
"previous": "<string>",
"meta": {
"processing_time": 0.2525252525,
"cursor_start": 123,
"cursor_end": 123,
"count": 123
}
}Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Path Parameters
Specify the delivery type to which your operations will be restricted.
asn, rma Query Parameters
Specify additional fields of the ASN OR RMA object to be included in the response.
See the selecting fields page for more information.
basic, all, customer_name, carrier_name, authorized_at, delivered_at, receive_by, processed_at, putaway_at, completed_at, ready_to_process_at, merchant_rma_number, merchant_status, carrier_tracking_number, merchant_order_number, item_count, container_count, label_count, exception_count, processing_comments, special_requirements, is_auto_commit, order, created_at, updated_at, supplier_name, expected_at, merchant_reference, supplier_invoice_reference, supplier_order_reference, shipment_type, bill_of_lading, tracking_number, standard_carrier_alpha_code, status_history Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.
basic, all, code, name, status, created_at, updated_at, brands, default_brand Specify additional fields of the Brand object to be included in the response. See the selecting fields page for more information.
basic, all, code, name, is_active, is_deleted, sort_order Specify additional fields of the Brand object to be included in the response. See the selecting fields page for more information.
basic, all, code, name, is_active, is_deleted, sort_order Specify additional fields of the Warehouse object to be included in the response.
all Specify additional fields of the DeliveryStatusHistory object to be included in the response. See the selecting fields page for more information.
all, delivery_item, status, exception, exception_status, comment, user, created_at, package Specify additional fields of the DeliveryTrackingNumber object to be included in the response. See the selecting fields page for more information.
all, tracking_number Using the filtering syntax, you may filter the results using the following fields:
idnamestatestatus
The default sort order is descending by primary key (sort=-id). The following fields are available for sorting:
idlabel
If specified as 1, the meta.count property of the response will be present and populated with the total count of items
matching the query before any paging is applied. This is not included by default to improve performance in some edge
cases and is not required to perform paging using the next property of the response.
See paging parameters for more information.
0 <= x <= 1A cursor for use in pagination which defines the last id of the next page of results, non-inclusive.
See paging parameters for more information on paging.
A cursor for use in pagination which defines the starting id of the next page of results.
See paging parameters for more information on paging.
A limit on the number of objects to be returned.
1 <= x <= 1000100
Response
A dictionary with a collection property that contains an array of up to limit RMA OR ASN objects. If no matching deliveries are found the array will be empty.
An ASN (Advanced Shipping Notification) delivery object.
- ASN
- RMA
Show child attributes
Show child attributes
This property describes the type of object in the response body.
ASN The Warehouse which is the destination for this delivery.
The internal id property used as a path parameter in a resource lookup.
Name of the supplier.
1 - 255The date and time the ASN delivery is expected in RFC 3339 section 5.6 notation.
"2019-12-03T21:06:26Z"
The "Merchant Reference" property. Uniqueness based on this field is enforced so an error will be given if a delivery with the same merchant_ref already exists.
1 - 45Unique reference number that will help to identify the invoice of a specific supplier.
1 - 45Unique reference number that will help to identify the order of a specific supplier.
1 - 45The shipment type that the carrier will use for delivery.
international_maritime_freight, international_air_freight, ftl_freight, ltl_freight, parcel, other The legal document used in freight shipping issued by the carrier which details the goods being shipped and the destination. This will not be available for Parcel or Other/Unknown shipment types.
1 - 45The SCAC (Standard Carrier Alpha Code) is typically marked on a shipper's containers and useful for identifying the carrier for International Maritime Freight type shipments. This should be 2 to 4 characters for a specific carrier.
4Unique identifier for the Delivery.
"11000020"
This describes the high-level, overall progress of the delivery.
new, processing, putting_away, pending_commit, complete, canceled This describes the low-level details of the current process of the delivery.
new, accepting, accepted, ready_to_process, processing, processing_exception, processed, putting_away, put_away, complete, canceled, void The overall delivery completion progress from 0 to 100 percent.
0 <= x <= 100The name of the carrier assigned to the delivery.
1 - 255The date and time the delivery was delivered in RFC 3339 section 5.6 notation. This corresponds with the "Delivered At" field in the ShipStream UI.
Optional Field
"2019-12-03T21:06:26Z"
The date and time the delivery was received in RFC 3339 section 5.6 notation.
Optional Field
"2019-12-03T21:06:26Z"
The date and time the delivery was processed in RFC 3339 section 5.6 notation.
Optional Field
"2019-12-03T21:06:26Z"
The date and time the delivery was put away in RFC 3339 section 5.6 notation.
Optional Field
"2019-12-03T21:06:26Z"
The date and time the delivery was completed in RFC 3339 section 5.6 notation.
Optional Field
"2019-12-03T21:06:26Z"
The date and time the delivery will be ready to process in RFC 3339 section 5.6 notation.
Optional Field
"2019-12-03T21:06:26Z"
The merchant status for a delivery.
1 - 45The quantity of delivery items.
The quantity of delivery containers.
The quantity of delivery labels.
The quantity of delivery exceptions.
Comments for the delivery are recorded in the History tab of the ShipStream Delivery view. This corresponds to Processing Options > Processing Comments when creating a delivery.
1 - 1000Special delivery requirements are set in the ShipStream Configurations.
This is a flag indicating whether or not inventory can be commited automatically. 0 - Disabled, 1 - Enabled, 2 - Use default from config.
The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field
"2017-07-21T17:32:28Z"
The date and time the object was last updated in RFC 3339 section 5.6 notation.
"2017-07-21T17:39:43Z"
The tracking numbers to be associated with the delivery for use by the customer.
Show child attributes
Show child attributes
This property describes the type of object in the response body.
DeliveryTrackingNumber The internal id property used as a path parameter in a resource lookup.
The tracking number for the delivery.
1 - 255A log of updates, comments and status changes added to this object.
Show child attributes
Show child attributes
The item being delivered which includes inventory quantities and stock movement information.
Show child attributes
Show child attributes
DeliveryItem The internal id property used as a path parameter in a resource lookup.
3
Reference an ASN or RMA Delivery type by id.
Show child attributes
Show child attributes
This property describes the type of object in the response body.
ASN, RMA The internal id property used as a path parameter in a resource lookup.
3
The quantity of items in the delivery.
The quantity of items expected in the delivery.
The quantity of items received at the time of delivery.
The quantity of missing items in the delivery.
The quantity of extra items in the delivery.
The quantity of items processed in the delivery.
The quantity of items in "put-away".
The quantity of items committed in the delivery.
The quantity of items returned in the delivery.
A flag indicating if the SKU merge email was sent.
true, false The item lot associated with the delivery item.
Show child attributes
Show child attributes
DeliveryItemLot The internal id property used as a path parameter in a resource lookup.
3
A reference to the Lot object associated with Warehouse Inventory Location.
Show child attributes
Show child attributes
This is a read-only property that describes the type of object in the response body.
Lot The internal id property used as a path parameter in a resource lookup.
54
The quantity of delivery items counted.
The quantity of delivery items for "put-away"
The location assigned to the delivery item.
Show child attributes
Show child attributes
DeliveryItemLocation The internal id property used as a path parameter in a resource lookup.
3
A Location describes a user-specified inventory address within a warehouse.
Show child attributes
Show child attributes
This property describes the type of object in the response body.
Location The internal id property used as a path parameter in a resource lookup.
42
The quantity of delivery items for "put-away" in this location.
The quantity of delivery items committed to this location.
An array of exceptions for the delivery item.
Show child attributes
Show child attributes
DeliveryItemException The internal id property used as a path parameter in a resource lookup.
3
A reference to a DeliveryItem object.
Show child attributes
Show child attributes
An object to represents a DeliveryContainer.
Show child attributes
Show child attributes
DeliveryContainer The internal id property used as a path parameter in a resource lookup.
3
An object to represent DeliveryContainerType.
Show child attributes
Show child attributes
DeliveryContainerType The internal id property used as a path parameter in a resource lookup.
3
The Merchant associated with this delivery container type.
Show child attributes
Show child attributes
Merchant The internal id property used as a path parameter in a resource lookup.
4
The type of delivery allowed for the container type.
asn, rma, other_delivery, cancellation, work_order_output The name of the delivery container type.
1 - 255The plural form of the delivery container type name used internally when referring to more than one type.
1 - 255This defines the weight of the DeliveryContainerType in imperial or metric units.
Show child attributes
Show child attributes
The weight quantity defined as a floating point value of up to 4 decimal places.
20
This can be an imperial or metric unit for weight.
lb, oz, kg, g This indicates whether or not the DeliveryContainerType is the default type.
true, false This indicates that the DeliveryContainerType is used only for internal system operations.
true, false This indicates if the container damage is noted or not.
none, noted, unnoted A description for why the delivery's weight is not matching the expected value.
none, shortage_noted, shortage_unnoted, overage|unknown The total weight of the delivery container when empty.
Show child attributes
Show child attributes
The weight quantity defined as a floating point value of up to 4 decimal places.
20
This can be an imperial or metric unit for weight.
lb, oz, kg, g This defines the full weight of the DeliveryContainer in imperial or metric units.
Show child attributes
Show child attributes
The weight quantity defined as a floating point value of up to 4 decimal places.
20
This can be an imperial or metric unit for weight.
lb, oz, kg, g The date and time the object was weighed in RFC 3339 section 5.6 notation.
Optional Field
"2019-12-03T21:06:26Z"
Reference an OrganizationUser or ClientUser by id.
Show child attributes
Show child attributes
OrganizationUser, ClientUser The internal id property used as a path parameter in a resource lookup.
3
A list of DeliveryContainerContent objects.
Show child attributes
Show child attributes
A reference to a DeliveryItem object.
Show child attributes
Show child attributes
DeliveryItem The internal id property used as a path parameter in a resource lookup.
The quantity of contents within a delivery container.
The quantity of items missing from the delivery container.
The quantity of items in the container counted per delivery container lot.
Show child attributes
Show child attributes
A reference to a Lot object. The Lot records the time some inventory was originated (first received or
otherwise created) and optionally a lot number and expiration date and may affect the order in which
inventory is "burned" depending on the LotType.
Show child attributes
Show child attributes
This property describes the type of object in the response body.
Lot The internal id property used as a path parameter in a resource lookup.
54
The quantity of items for the specified delivery container lot.
A description of the container condition upon reception.
The quantity of items in the delivery container.
The Lot records the time some inventory was originated (first received or
otherwise created) and optionally a lot number and expiration date and may affect the order in which
inventory is "burned" depending on the LotType.
Show child attributes
Show child attributes
This is a read-only property that describes the type of object in the response body.
Lot The internal id property used as a path parameter in a resource lookup.
54
The status of the exception associated with the delivery item.
new, pending, approved, rejected, void The signature type for the delivery exception for this item.
1, -1 The reason given for this item's delivery exception.
1 - 45A comment included in the item's delivery exception.
The quantity of exceptions for this delivery item.
The status of the delivery at the time the history event was added.
new, accepting, accepted, ready_to_process, processing, processing_exception, processed, putting_away, put_away, complete, canceled, void The status of the processing exception.
new, pending, approved, rejected, void An optional description for the history event which can be added programatically.
Reference an OrganizationUser or ClientUser by id.
The date and time the object was created in RFC 3339 section 5.6 notation.
"2017-07-21T17:32:28Z"
Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Merchant The internal id property used as a path parameter in a resource lookup.
4
Merchant code may only contain letters (a-z), numbers (0-9) or underscore(_), the first character must be a letter.
1 - 32"acme_inc"
Any string which uniquely identifies a Merchant.
1 - 64"ACME Inc."
Lifecycle status of the Merchant:
active: Merchant is operational and available for usesuspended: Temporarily on hold, can be easily reactivatedinactive: Long-term offline status, reactivation is possible but may require additional stepsarchived: Soft delete status, manual recovery required
active, inactive, suspended, archived "active"
The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field
"2017-07-21T17:32:28Z"
The date and time the object was last updated in RFC 3339 section 5.6 notation.
Optional Field
"2017-07-21T17:39:43Z"
A merchant must have one or more brands which may share the same pool of inventory. Brands can be used for
customizing presentation and behaviors and often correspond to distinct lines of business or market presences.
Optional Field
This is the primary brand used when defining only the merchant for operations such as creating a new product.
Optional Field
Show child attributes
Show child attributes
This is a read-only property that describes the type of object in the response body.
Warehouse The internal id property used as a path parameter in a resource lookup.
3
The display name for the Warehouse.
255"East Coast 1"
This flag determines if the Warehouse is active and viable for fulfillment.
true
True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.
The resource path for the next page of results if any are expected.
The resource path for the previous page of results if any are expected.
Additional metadata pertaining to the response.
Show child attributes
Show child attributes
Total time in which request is processed and response is sent back.
0.2525252525
A cursor for use in pagination which defines the starting id of the next page of results.
See paging parameters for more information on paging.
A cursor for use in pagination which defines the last id of the next page of results, non-inclusive.
See paging parameters for more information on paging.
The total number of items matching the query before applying paging parameters.
This field is only present if the query parameter count=1 is present in the request.
Was this page helpful?