Skip to content

OutboundStatus

Use this API to get status of the specified outbound.

POST /openapi/fulfillment/outbound/v1/status

Request Body

Parameter Type Required Description
outboundNo string true Identifiers of outbound

Response Body

Name Type Description
code string SUCCESS | ERROR
message string The status code detailed explanation.
data object Please refer to Response Data for details
extra string An exception message (should be empty most of the time).
transactionId string An unique string identifier for each request.
pricingStrategy string Shows you whether this api call will be charged by Ginee, currently all APIs are FREE even though this tag is PAY.

Response Data

Name Type Description
actualOutboundQuantity int Actual outbound quantity
itemSku string Item Sku
outboundQuantity int Outbound Quantity
outboundStatus string Please refer to Outbound Status for details

Request Example

Example

curl -X POST  \
-H "X-Advai-Country: ID" \
-H "Authorization: {Your Access Key} + ':' + signature" \
-H "Content-Type: application/json" \
-d '{
        "outboundNo":"89e99fcaee0a3ea84c"
    }' \
"{Ginee Host}/openapi/fulfillment/outbound/v1/status"

Success

{
    "code": "SUCCESS",
    "message": "OK",
    "data": {
        "actualOutboundQuantity": 0,
        "itemSku": "textM7",
        "outboundQuantity": 2,
        "outboundStatus": "shipping"
    },
"extra": null,
"transactionId": "3d6523886f646e6d"
}

Failure

{
    "code": "PARAMETER_ERROR",
    "message": "Parameter is invalid: Parameter should not be empty: outboundNo ",
    "data": null,
    "extra": null
}