GetPrintingDocumentInfo¶

Use this API to get printing document information.

GET /openapi/order/v1/print-document/get

Request Parameters¶

Parameter	Type	Required	Description
`orderId`	`string`	`true`	Order id in Ginee

Response Parameters¶

Name	Type	Description
`orderId`	`string`	Ginee order id
`channelId`	`string`	Channel id
`orderSn`	`string`	Channel order number
`packageNumber`	`string`	Package number
`trackingNumber`	`string`	Tracking number
`cod`	`boolean`	cod, true or false
`lastMileTrackingNumber`	`string`	Last mile tracking number
`recipientAddress`	`object`	Recipient address,See RecipientAddress Info
`pickupCode`	`string`	For drivers to quickly identify parcel to be picked up. Only returned for ID and TH local orders which use instant+sameday for delivery.
`isLmDgBool`	`int`	Use this field to indicate order contains dangerous goods or not. dg:1 non-dg:0
`mutualCheck`	`int`	only apply for ID/VN shops. mutual_check indicates whether the parcel is eligible for Return-on-the-Spot (RoS) co-check.If mutual_check=1, then the parcel is RoS eligible, where drivers and buyers can co-check the parcel. Buyer can then choose to accept or reject the parcel on the spot. If mutual_check=0, then the parcel is ineligible for RoS.
`recipientSortCode`	`object`	The sort code of recipient. See RecipientSortCode Info
`senderSortCode`	`object`	The sort_code of sender. See SenderSortCode Info
`returnSortCode`	`object`	The sort code for 3PL doing RTS. See ReturnSortCode Info
`deliverArea`	`object`	Zone name.
`spxSubDistrict`	`object`	The sub-district of recipient's address.
`delySunLabel`	`object`	Probability of Successful Sunday Delivery. The value of L(low), M(medium), H(high) represent the chances of successful delivery attempts on Sunday.
`sortCode`	`object`	Sort code,See SortCode Info
`serviceType`	`string`	Logistics service type,EZ or ECO
`itemTotalWeight`	`bigDecimal`	Total weight of item, Unit: g

RecipientAddress Info¶

Name	Type	Description
`name`	`string`	name
`phone`	`string`	phone
`fullAddress`	`string`	Full address

RecipientSortCode Info¶

Name	Type	Description
`firstRecipientSortCode`	`string`	The first-level sort_code of recipient.
`secondRecipientSortCode`	`string`	The second-level sort_code of recipient.
`thirdRecipientSortCode`	`string`	The third-level sort_code of recipient.

SenderSortCode Info¶

Name	Type	Description
`firstRecipientSortCode`	`string`	The first-level sort_code of sender.
`secondRecipientSortCode`	`string`	The second-level sort_code of sender.
`thirdRecipientSortCode`	`string`	The third-level sort_code of sender.

ReturnSortCode Info¶

Name	Type	Description
`returnFirstSortCode`	`string`	The first-level sort code for 3PL doing RTS.

SortCode Info¶

Name	Type	Description
`areaCode`	`string`	Area code
`zipCode`	`string`	Zip code
`hubCode`	`string`	Hub code

Request Example¶

Example

curl -X GET  \
-H "X-Advai-Country: ID" \
-H "Authorization: {Your Access Key} + ':' + signature" \
-H "Content-Type: application/json" \
"{Ginee Host}/openapi/order/v1/print-document/get?orderId=SO6667381DFA4F8C0001CB2E68

Success

{
    "code": "SUCCESS",
    "message": "成功",
    "data": {
        "orderSn": "576938077251536698",
        "packageNumber": "ABC",
        "trackingNumber": "",
        "recipientAddress": {
            "name": "Fitri buk adil",
            "phone": "(+62)081252192660",
            "fullAddress": "Jawa Timur, Kab. Bondowos o, Curahdami, jl Brigpol s udarlan... brat lpngan petung, mas ing gang mas jid,,,penambangan rt8,rw5"
        },
        "cod": false,
        "sortCode": {
            "areaCode": null,
            "zipCode": null,
            "hubCode": "NJVTT06015184038"
        },
        "lastMileTrackingNumber": null,
        "serviceType": "EZ"
        "itemTotalWeight": "29.00"
    },
    "extra": null,
    "pricingStrategy": "PAY"
}

Failure

{
    "code": "PARAMETER_ERROR",
    "message": "Kesalahan parameter, silakan periksa permintaan Anda apakah memiliki parameter ilegal",
    "data": null,
    "extra": null,
    "pricingStrategy": "FREE"
}

Note

You need to check the code to see if the operation was successful. If failed, see message for detail reason.