Shipments


The shipment services provide a mechanism to manage shipments if your company is using ‘Ship via Quipt’. The primary purpose is to download the necessary packing and shipment documents. If you currently do not utilize ‘Ship Via Quipt’ all details can be retrieved here using the order services. Click here for a few use cases using the shipment services.

Get Shipments

This services allows a partner to retrieve a paged list of shipment records.

URLhttps://api.getquipt.com/v2/orders/shipment/{pageSize}/{pageNumber}
 
Methodget

Parameters:

Name Description Type Required
{pageSize} The maximum number of records to return. The maximum value is 200. Int Yes
{pageNumber} The page to retrieve. String No
&statuses A comma separated list of shipment statuses, (2 = Pending, 32 = New, 128 = Ready, 512 = Generating, 1024 = Generated, 4096 = Exported, 16384 = Printed, 131072 = Pickup Requested, 524288 = Picked Up, 2097152 = Error, 8388608 = Canceled). String No
&orderIds A comma separated list of order ids. String No
&warehouseIds A comma separated list of warehouses. String No
&include A comma separated list of properties to include with result. Valid options are Invoices, PackingSlips, ShipByTruckRequests, and Labels. String No

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Result The collection of shipment results. ShipmentResult[]
Paging Paging information for the records returned. Paging
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

Get Shipment By Id

This services allows a partner to retrieve a specific shipment.

URLhttps://api.getquipt.com/v2/orders/shipment/id/{id}
 
Methodget

Parameters:

Name Description Type Required
{id} The maximum number of records to return. The maximum value is 200. Int Yes
&include A comma separated list of properties to include with result. Valid options are Invoices, PackingSlips, ShipByTruckRequests, and Labels. String No

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Result The shipment result. ShipmentResult

Acknowledge Shipment

This services allows a partner to acknowledge the receipt of a shipment.

URLhttps://api.getquipt.com/v2/orders/shipment/acknowledge
 
Methodpost

Parameters:

Name Description Type
Acknowledgements The collection of shipment acknowledgements for the request. Shipment.Acknowledgement[]
TransactionId The transaction id for the request. String

Sample Header:

Sample Request (JSON):

Sample Response (JSON):

Response Definitions:

Name Description Type
ReportId The id used to lookup report details using the report endpoint. Guid
RecordsReceived The number of records received. Int
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

Batch Report

This service allows a partner to retrieve the detailed report generated when any of the action services are used. The result of ‘Acknowledge Shipment’ returns the {id} used to retrieve the report from this service.

URLhttps://api.getquipt.com/v2/orders/shipment/report/{id}/{pageSize}/{pageNumber}
 
Methodget

Parameters:

Name Description Type Required
{pageSize} The maximum number of records to return. The maximum value is 200. Int Yes
{pageNumber} The page to retrieve. String No
{id} The report identifier. Guid Yes
&includeLines Flag whether or not to include the line details. Boolean No

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Result The collection of shipment reports. ShipmentReport[]
ReportId The report id. Guid
ReportTime The time the report was generated. DateTime
ReportStatus The current status of the report. Int
Paging Paging information for the records returned. Paging
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

Shipments


The shipment services provide a mechanism to manage shipments if your company is using ‘Ship via Quipt’. The primary purpose is to download the necessary packing and shipment documents. If you currently do not utilize ‘Ship Via Quipt’ all details can be retrieved here using the order services. Click here for a few use cases using the shipment services.

Get Shipments

This services allows a partner to retrieve a paged list of shipment records.

URLhttps://api.getquipt.com/v2/orders/shipment/{pageSize}/{pageNumber}
 
Methodget

Parameters:

Name Description Type Required
{pageSize} The maximum number of records to return. The maximum value is 200. Int Yes
{pageNumber} The page to retrieve. String No
&statuses A comma separated list of shipment statuses, (2 = Pending, 32 = New, 128 = Ready, 512 = Generating, 1024 = Generated, 4096 = Exported, 16384 = Printed, 131072 = Pickup Requested, 524288 = Picked Up, 2097152 = Error, 8388608 = Canceled). String No
&orderIds A comma separated list of order ids. String No
&warehouseIds A comma separated list of warehouses. String No
&include A comma separated list of properties to include with result. Valid options are Invoices, PackingSlips, ShipByTruckRequests, and Labels. String No

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Result The collection of shipment results. ShipmentResult[]
Paging Paging information for the records returned. Paging
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

Get Shipment By Id

This services allows a partner to retrieve a specific shipment.

URLhttps://api.getquipt.com/v2/orders/shipment/id/{id}
 
Methodget

Parameters:

Name Description Type Required
{id} The maximum number of records to return. The maximum value is 200. Int Yes
&include A comma separated list of properties to include with result. Valid options are Invoices, PackingSlips, ShipByTruckRequests, and Labels. String No

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Result The shipment result. ShipmentResult

Acknowledge Shipment

This services allows a partner to acknowledge the receipt of a shipment.

URLhttps://api.getquipt.com/v2/orders/shipment/acknowledge
 
Methodpost

Parameters:

Name Description Type
Acknowledgements The collection of shipment acknowledgements for the request. Shipment.Acknowledgement[]
TransactionId The transaction id for the request. String

Sample Header:

Sample Request (JSON):

Sample Response (JSON):

Response Definitions:

Name Description Type
ReportId The id used to lookup report details using the report endpoint. Guid
RecordsReceived The number of records received. Int
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

Batch Report

This service allows a partner to retrieve the detailed report generated when any of the action services are used. The result of ‘Acknowledge Shipment’ returns the {id} used to retrieve the report from this service.

URLhttps://api.getquipt.com/v2/orders/shipment/report/{id}/{pageSize}/{pageNumber}
 
Methodget

Parameters:

Name Description Type Required
{pageSize} The maximum number of records to return. The maximum value is 200. Int Yes
{pageNumber} The page to retrieve. String No
{id} The report identifier. Guid Yes
&includeLines Flag whether or not to include the line details. Boolean No

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Result The collection of shipment reports. ShipmentReport[]
ReportId The report id. Guid
ReportTime The time the report was generated. DateTime
ReportStatus The current status of the report. Int
Paging Paging information for the records returned. Paging
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]