ListDeliveryOrder¶

Use this api to search delivery order information.

POST /openapi/delivery/v1/order/list

Request Parameters¶

Parameter	Type	Required	Description
`size`	`integer`	`false`	Page size, default is 100, max page entries should be less than 200
`page`	`interge`	`false`	Page number, default 0
`deliveryOrderStatus`	`String`	`false`	Default null, please refer Order Status for details
`warehouseProviderId`	`string`	`true`	Warehouse provider id in Ginee
`ownerId`	`string`	`true`	Owner id in Ginee
`createSince`	`UTC Timestamp`	`false`	The createSince and createTo fields specify a date range for retrieving inventories (based on the delivery order create time)
`createTo`	`UTC Timestamp`	`false`	The createSince and createTo fields specify a date range for retrieving inventories (based on the delivery order create time)
`lastUpdateSince`	`UTC Timestamp`	`false`	The lastUpdateSince and lastUpdateTo fields specify a date range for retrieving inventories (based on the delivery order update time)
`lastUpdateTo`	`UTC Timestamp`	`false`	The lastUpdateSince and lastUpdateTo fields specify a date range for retrieving inventories (based on the delivery order update time)

Response Parameters¶

Name	Type	Description
`deliveryOrderId`	`string`	Delivery order id in Ginee
`deliveryOrderSn`	`string`	Unique number of delivery order, like "511260640034038", It's use for delivery order invoice
`orderId`	`string`	Order id
`deliveryOrderType`	`object`	Please refer Delivery Order Type for details
`deliveryOrderStatus`	`object`	Please refer Delivery Order Status for details
`ownerId`	`string`	Owner id in Ginee
`ownerCode`	`string`	Owner id in Provider
`createAt`	`UTC timestamp`	Delivery order create date time
`lastUpdateAt`	`UTC Timestamp`	Delivery order last update date time

Request Example¶

Example

curl -X POST  \
-H "X-Advai-Country: ID" \
-H "Authorization: {Your Access Key} + ':' + signature" \
-H "Content-Type: application/json" \
-d '{
        "page":0,
        "size":50,
        "deliveryOrderStatus":"ACCEPTED",
        "warehouseProviderId":"WPDDCC5369BD1160001ADD698",
        "ownerId":"WHDDCC5369BD1160001ADD698",
        "createSince":"2020-12-01T16:00:04Z",
        "createTo":"2021-01-01T16:00:04Z",
        "lastUpdateSince":"2020-12-01T16:00:04Z",
        "lastUpdateTo":"2021-01-01T16:00:04Z"
    }' \
"{Ginee Host}/openapi/delivery/v1/order/list"

Success

{
    "code":"SUCCESS",
    "message":"OK",
    "data":{
        "page":0,
        "size":50,
        "total":1,
        "content":[
            {
                "deliveryOrderId":"DO5DDCC5369BD1160001ADD698",
                "deliveryOrderSn":"511260640034038",
                "orderId":"SO5FE443886B2F07000115674F",
                "deliveryOrderType":"SALE_ORDER",
                "deliveryOrderStatus":"ACCEPTED",
                "ownerId": "OO5DDCC5369BD1160001ADD698",
                "ownerCode":"gf001",
                "createAt":"2020-10-27T15:50:19Z",
                "lastUpdateAt":"2020-12-27T21:27:46Z"
            }
        ]
    },
    "extra":null,
    "transactionId":"4fec7eeaaa1019e7"
}