Requests


The request services below provide the ability to manage requests expected to be completed by Quipt merchants. The provided services can be used to download, acknowledge, and close requests. Click here for a few use cases using the request services.

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

Get Requests

This services allows a partner to retrieve a paged list of request records a partner has currently listed within Quipt.

URLhttps://api.getquipt.com/v2/requests/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
&status A comma separated list of request statuses, (2 = Pending, 4 = Open, 8 = Closed, and, 16 = Canceled). Int No
&channelId Either the Quipt identifier for the channel, or the code set as the partner reference within the partner's settings. String No
&include A comma separated list of properties to include with result. Valid options are Group, Lines.FillLine, Lines.Tracking, Lines.OrderLine, Lines.OrderLine.Fulfillments, and Lines.OrderLine.Acknowledgements. String No

Response Definitions:

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

This services allows a partner to retrieve a paged list of request records a partner has currently listed within Quipt.

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

Parameters:

Name Description Type Required
{poNumber} 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 Group, Lines.FillLine, Lines.Tracking, Lines.OrderLine, Lines.OrderLine.Fulfillments, and Lines.OrderLine.Acknowledgements. String No

Response Definitions:

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

This services allows a partner to retrieve a paged list of inventory records a partner has currently listed within Quipt.

URLhttps://api.getquipt.com/v2/requests/purchase/referencenumber/{refNumber}
 
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 Group, Lines.FillLine, Lines.Tracking, Lines.OrderLine, Lines.OrderLine.Fulfillments, and Lines.OrderLine.Acknowledgements. String No

Response Definitions:

Name Description Type
Result The request result. RequestResult

Get Request By Id

This services allows a partner to retrieve a paged list of inventory records a partner has currently listed within Quipt.

URLhttps://api.getquipt.com/v2/requests/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 Group, Lines.FillLine, Lines.Tracking, Lines.OrderLine, Lines.OrderLine.Fulfillments, and Lines.OrderLine.Acknowledgements. String No

Response Definitions:

Name Description Type
Result The request result. RequestResult

Acknowledge

This service provides a mechanism to acknowledge a request. It provides a mechanism to both accept and reject a reqyest.

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

Parameters:

Name Description Type Required
Acknowledgements The collection of request acknowledgements for the request. Request.Acknowledgement[] Yes
TransactionId The transaction id for the request. String No

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

Create

This services allows a partner to create a new request for a closed order.

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

Name Description Type Required
Requests The collection of requests to create. Request[] Yes
UnidentifiedItems The collection of unidentified items to create. UnidentifiedItem[] Yes
TransactionId The transaction id for the request. String No

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 services allows a partner to request a cancellation of a request.

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

Parameters:

Name Description Type Required
Requests The collection of requests to cancel. Request.CancelRequest[] Yes
TransactionId The transaction id for the request. String No

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 a request. The primary purpose of archiving an request is to remove it from the lists that are obtained using ‘Get Requests’. This mechanism is not required, and will be automatically applied after 30 days.

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

Parameters:

Name Description Type Required
RequestIds The collection of request ids. Guid[] Yes
TransactionId The transaction id for the request. String No

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’, ‘Cancel’, ‘Create’, ‘Return Update’, ‘Lost Shipment Update’, ‘Intercept Update’, ‘Missing Accessory Update’, ‘Credit Update’ and ‘Archive’ returns the {id} used to retrieve the report from this service.

URLhttps://api.getquipt.com/v2/requests/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. RequestReport[]
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[]