GetInboundOrder¶

Use this api to get inbound order details.

GET /openapi/inbound-order/v1/get

Request Parameters¶

Parameter	Type	Required	Description
`inboundOrderId`	`long`	`true`	inboundOrderId

Response Parameters¶

Name	Type	Description
`id`	`long`	inbound order id
`userId`	`string`	ginee user id
`no`	`string`	inbound order no
`warehouseId`	`string`	ginee warehouse id
`status`	`string`	inbound order status, (CREATE,PENDING,PART_COMPLETE,PART_INVALID,COMPLETE,INVALID)
`remark`	`string`	remark
`planAmount`	`float`	Plan amount
`realAmount`	`float`	Real amount
`planQuantity`	`int`	Plan quantity
`realQuantity`	`int`	Real quantity
`deliveryMethod`	`string`	Delivery method(EXPRESS_DELIVERY,SELF_PICKED_UP,DEFAULT)
`waybillNumber`	`string`	Waybill number
`items`	`array[]`	Inbound order details
`createDatetime`	`datetime`	Create date and time
`updateDatetime`	`datetime`	Update date and time

Items¶

Name	Type	Description
`id`	`long`	Inbound Order item id
`status`	`string`	inbound order status, (CREATE,PENDING,PART_COMPLETE,PART_INVALID,COMPLETE,INVALID)
`masterVariationId`	`string`	Master variation id
`masterSku`	`string`	Master sku
`planQuantity`	`long`	Plan quantity
`realQuantity`	`long`	Real quantity
`planPrice`	`float`	Purchase unit price for planned outgoing shipments
`realPrice`	`float`	Actual outgoing purchase unit prices
`planAmount`	`float`	Plan amount
`realAmount`	`float`	Real amount
`remark`	`string`	Remark
`failReason`	`string`	Fail feason

Request Example¶

Example

curl --location --request GET '{Ginee Host}/openapi/inbound-order/v1/get?inboundOrderId={Ginee Inbound Order Id}' \
    --header 'Content-Type: application/json' \
    --header 'X-Advai-Country: ID' \
    --header 'Authorization: Authorization: {Your Access Key} + ':' + signature'

Success

{
    "code": "SUCCESS",
    "message": "成功",
    "data": {
        "id": 7972,
        "userId": "U5DDCC5369BD1160001ADD698",
        "no": "Adj-1762049187865903104",
        "warehouseId": "WW65B37F8EE828860001306038",
        "status": "COMPLETE",
        "planAmount": 500.000000,
        "realAmount": 500.000000,
        "remark": "this is remark",
        "deliveryMethod": "EXPRESS_DELIVERY",
        "waybillNumber": "1234kkk",
        "createDatetime": "2024-02-26T09:37:18.789Z",
        "updateDatetime": "2024-02-26T09:37:19.128Z",
        "planQuantity": 3,
        "realQuantity": 3,
        "items": [
            {
                "id": 7790,
                "status": "COMPLETE",
                "masterVariationId": "MV65B9F3A36522050001ED8DA0",
                "masterSku": "pos0131001sku",
                "planQuantity": 1,
                "realQuantity": 1,
                "planPrice": 100.000000,
                "realPrice": 100.000000,
                "planAmount": 100.000000,
                "realAmount": 100.000000,
                "remark": null,
                "failReason": ""
            },
            {
                "id": 7791,
                "status": "COMPLETE",
                "masterVariationId": "MV65BF63D0652205000161D57C",
                "masterSku": "pos0204001sku",
                "planQuantity": 2,
                "realQuantity": 2,
                "planPrice": 200.000000,
                "realPrice": 200.000000,
                "planAmount": 400.000000,
                "realAmount": 400.000000,
                "remark": null,
                "failReason": ""
            }
        ]
    },
    "extra": null,
    "pricingStrategy": "PAY"
}

Parameter error

{
    "code": "SUCCESS",
    "message": "OK",
    "data": [],
    "extra": null,
    "pricingStrategy": "PAY"
}