Orders


The order services provide the ability to manage orders expected to be fulfilled by Quipt merchants. The provided services may be used to download, acknowledge, ship, invoice, and cancel orders. Click here for a few use cases using the order services.

Download our postman collection to see how the endpoints can be used.

Get Orders

This service allows a partner to retrieve a paged list of orders placed by a retailer.

URLhttps://api.getquipt.com/v2/orders/purchase/{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
&orderStatus A comma separated list of order statuses, (2 = Pending, 4 = Open, 8 = Shipped, and, 16 = Canceled). Int No
&include A comma separated list of properties to include with result. Valid options are Invoices, Shipments, Cancellations, PackingSlips, ShipByTruckRequests, Payments, Fulfillments, Acknowledgements, and SubstitutionFor. String No

Response Definitions:

Name Description Type
Paging Paging information for the records returned. Paging
Result The collection of purchase order results. PurchaseOrderResult[]
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 Order By Id

This service allows a partner to retrieve an order by the Quipt identifier.

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

Parameters:

Name Description Type Required
{id} The Quipt identifier. Guid Yes
&include A comma separated list of properties to include with result. Valid options are Invoices, Shipments, Cancellations, PackingSlips, ShipByTruckRequests, Payments, Fulfillments, Acknowledgements, and SubstitutionFor. String No

Response Definitions:

Name Description Type
Result The purchase order result. PurchaseOrderResult

Get Order By Purchase Order Number

This service allows a partner to retrieve an order by the retailer’s original order number.

URLhttps://api.getquipt.com/v2/orders/purchase/ordernumber/{poNumber}
 
Methodget

Parameters:

Name Description Type Required
{retailerId} Either the Quipt identifier for the channel, or the code set as the partner reference within the partner's settings. Guid Yes
{poNumber} The original purchase order number. String No
&include A comma separated list of properties to include with result. Valid options are Invoices, Shipments, Cancellations, PackingSlips, ShipByTruckRequests, Payments, Fulfillments, Acknowledgements, and SubstitutionFor. String No

Response Definitions:

Name Description Type
Paging Paging information for the records returned. Paging
Result The collection of purchase order results. PurchaseOrderResult[]
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[]

Create Order

This service provides a mechanism to acknowledge an order. Use service provides the mechanisms to either accept and reject an order.

URLhttps://api.getquipt.com/v2/orders/purchase/create
 
Methodpost

Body Definitions:

Name Description Type
Acknowledgements The collection of purchase order acknowledgements for the request. PurchaseOrder.Acknowledgement[]
TransactionId The transaction id for the request. String

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[]

Acknowledge

This service allows a partner apply shipment details to an order.

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

Parameters:

Name Description Type
Shipments The collection of purchase order shipment details for the request. PurchaseOrder.Shipment[]
TransactionId The transaction id for the request. String

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[]

Cancel

This service provides a mechanism to invoice of shipped orders. Invoicing an orders is required, but it is not required to be completed using this service. If this flow cannot be supported turn ‘On’ auto invoicing within company settings.

URLhttps://api.getquipt.com/v2/orders/purchase/cancel
 
Methodpost

Parameters:

Name Description Type
Invoices The collection of purchase order invoices for the request. PurchaseOrder.Invoice[]
TransactionId The transaction id for the request. String

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[]

Archive

This service allows a partner to archive an order. The primary purpose of archiving an order is to remove it from the lists that are obtained using ‘Get Orders’. This mechanism is not required, and will be automatically applied after 30 days.

URLhttps://api.getquipt.com/v2/orders/purchase/archive
 
Methodpost

Parameters:

Name Description Type
PurchaseOrderIds The collection of purchase order ids for the request. Guid[]
TransactionId The transaction id for the request. String

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 Order’, ‘Ship Order’, ‘Invoice Order’, and ‘Archive Order’ returns the {id} used to retrieve the report from this service.

URLhttps://api.getquipt.com/v2/orders/purchase/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

Response Definitions:

Name Description Type
Result The collection of purchase order reports. PurchaseOrderReport[]
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[]

Orders


The order services provide the ability to manage orders expected to be fulfilled by Quipt merchants. The provided services may be used to download, acknowledge, ship, invoice, and cancel orders. Click here for a few use cases using the order services.

Download our postman collection to see how the endpoints can be used.

Get Orders

This service allows a partner to retrieve a paged list of orders placed by a retailer.

URLhttps://api.getquipt.com/v2/orders/purchase/{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
&orderStatus A comma separated list of order statuses, (2 = Pending, 4 = Open, 8 = Shipped, and, 16 = Canceled). Int No
&include A comma separated list of properties to include with result. Valid options are Invoices, Shipments, Cancellations, PackingSlips, ShipByTruckRequests, Payments, Fulfillments, Acknowledgements, and SubstitutionFor. String No

Response Definitions:

Name Description Type
Paging Paging information for the records returned. Paging
Result The collection of purchase order results. PurchaseOrderResult[]
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 Order By Id

This service allows a partner to retrieve an order by the Quipt identifier.

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

Parameters:

Name Description Type Required
{id} The Quipt identifier. Guid Yes
&include A comma separated list of properties to include with result. Valid options are Invoices, Shipments, Cancellations, PackingSlips, ShipByTruckRequests, Payments, Fulfillments, Acknowledgements, and SubstitutionFor. String No

Response Definitions:

Name Description Type
Result The purchase order result. PurchaseOrderResult

Get Order By Purchase Order Number

This service allows a partner to retrieve an order by the retailer’s original order number.

URLhttps://api.getquipt.com/v2/orders/purchase/ordernumber/{poNumber}
 
Methodget

Parameters:

Name Description Type Required
{retailerId} Either the Quipt identifier for the channel, or the code set as the partner reference within the partner's settings. Guid Yes
{poNumber} The original purchase order number. String No
&include A comma separated list of properties to include with result. Valid options are Invoices, Shipments, Cancellations, PackingSlips, ShipByTruckRequests, Payments, Fulfillments, Acknowledgements, and SubstitutionFor. String No

Response Definitions:

Name Description Type
Paging Paging information for the records returned. Paging
Result The collection of purchase order results. PurchaseOrderResult[]
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[]

Create Order

This service provides a mechanism to acknowledge an order. Use service provides the mechanisms to either accept and reject an order.

URLhttps://api.getquipt.com/v2/orders/purchase/create
 
Methodpost

Body Definitions:

Name Description Type
Acknowledgements The collection of purchase order acknowledgements for the request. PurchaseOrder.Acknowledgement[]
TransactionId The transaction id for the request. String

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[]

Acknowledge

This service allows a partner apply shipment details to an order.

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

Parameters:

Name Description Type
Shipments The collection of purchase order shipment details for the request. PurchaseOrder.Shipment[]
TransactionId The transaction id for the request. String

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[]

Cancel

This service provides a mechanism to invoice of shipped orders. Invoicing an orders is required, but it is not required to be completed using this service. If this flow cannot be supported turn ‘On’ auto invoicing within company settings.

URLhttps://api.getquipt.com/v2/orders/purchase/cancel
 
Methodpost

Parameters:

Name Description Type
Invoices The collection of purchase order invoices for the request. PurchaseOrder.Invoice[]
TransactionId The transaction id for the request. String

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[]

Archive

This service allows a partner to archive an order. The primary purpose of archiving an order is to remove it from the lists that are obtained using ‘Get Orders’. This mechanism is not required, and will be automatically applied after 30 days.

URLhttps://api.getquipt.com/v2/orders/purchase/archive
 
Methodpost

Parameters:

Name Description Type
PurchaseOrderIds The collection of purchase order ids for the request. Guid[]
TransactionId The transaction id for the request. String

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 Order’, ‘Ship Order’, ‘Invoice Order’, and ‘Archive Order’ returns the {id} used to retrieve the report from this service.

URLhttps://api.getquipt.com/v2/orders/purchase/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

Response Definitions:

Name Description Type
Result The collection of purchase order reports. PurchaseOrderReport[]
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[]