Get On-hold Orders
In cases where the partner requires the seller to block the inventory for orders received and process them upon receiving confirmation. Such orders are fetched as on-hold orders for blocking the inventory. This REST API details the method in which the on-hold orders are fetched from the marketplace using the Unicommerce API.
Tip
- This api offers the marketplace an added functionality to hold some orders for review and then decide to either accept or cancel the order. This can be pragmatic in case of orders with large quantities or with valuable items. In Uniware the inventory for such orders is blocked, so that the inventory remains available upon confirmation of order for processing by MP.
- It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.
Basic Information
NAME | DETAILS |
---|---|
Usage: | Optional |
Endpoint: | /orders/pendency |
Request Type: | GET |
Scheme: | HTTPS |
Header (apiKey): | accessToken (got from Get Authentication) |
Sample URL
https://{MarketplaceBaseUrl}/orders/pendency?pageNumber=1&pageSize=50&orderDateFrom=2022-01-02T08:12:53+05:30&orderDateTo=2022-01-20T08:12:53+05:30
Query Parameters
PARAMETERS | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|
pageNumber | string | Page number | Yes | Default: 1 |
pageSize | string | Page size | Yes | Fixed: 50 |
orderDateFrom | date | Order date from | No | Format: yyyy-MM-dd’T’HH:mm:ss+05:30 Eg: 2017-01-02T08:12:53+05:30 (for Indian time zone) |
orderDateTo | date | Order date to | No | - |
Response Payload
{
"pendencies": [
{
"orderId": "123456",
"orderStatus": "PENDING_VERIFICATION",
"orderItems": [
{
"orderItemId": "orderitem-1234",
"productId": "mouse",
"variantId": "color_red",
"sku": "MOUSE5-123",
"title": "Gaming Mouse 5 Buttons",
"status": "CREATED",
"quantity": 1,
"onHold": false,
"packetNumber": 1
}
]
}
],
"hasMore": true
}
Response Payload (Error)
{
"message":"String"
}
Response Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|---|
1 | pendencies | list | List of order pendencies | - | - |
1.1 | orderId | string | Order ID | Yes | - |
1.3 | orderStatus | string | Status of the order | Yes | Fixed: PENDING_VERIFICATION |
1.8 | orderItems | list | List of items in the order | - | - |
1.8.1 | orderItemId | string | The ID of the item(s) present inside the order | Yes | - |
1.8.2 | productId | string | Product ID of the item | Yes | - |
1.8.3 | variantId | string | Variant ID of the item | Yes | - |
1.8.4 | sku | string | SKU code of the item on the marketplace | Yes | - |
1.8.5 | title | string | Title of the item | No | - |
1.8.6 | status | string | Generally same as orderStatus . Only is case of partial order fulfilment the status of item in the order will vary. |
Yes | Allowable: same as orderStatus |
1.8.7 | quantity | integer | Qty of the item ordered | Yes | Default: 1 |
1.8.8 | onHold | boolean | true if order not available for processing | No | Default: false |
1.8.9 | packetNumber | integer | No. of parcels in which the order has to be processed | No | Default: 0 |
1.8.10 | hasMore | boolean | If there are more enteries on next page, pass ‘true’ | Yes | Default: false |
E | message | string | Error message Eg: Invalid User/Token | No | - |
Error Codes
Refer Response Codes section to know about specific errors codes.
FAQs/Notes
Q1. Will the actual orders get created using this API?
Ans. No. It will create a pendency only, it will block inventory on basis of particular orders and later after seller confirmation orders will be fetched and created.
Q2. What is Pendency?
Ans. Pendency means awaiting state. Support article for reference: Channel Pendency