Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Order

Check the status of a card inventory order.

This API is used to get inventory order information from partners.

Http Status Code

<table><thead><tr><th>Name</th><th>Comment</th></tr></thead><tbody><tr><td>200</td><td>success</td></tr><tr><td>400</td><td>bad request, like unsupported operation</td></tr><tr><td>401</td><td>Unauthorized</td></tr></tbody></table>
get/programs/{programCode}/order/{orderIdentifier}

Path parameters

programCodestring required

The program code associated with the inventory order.

orderIdentifierstring required

The unique identifier of the order whose status is being queried.

Headers

X-GD-RequestIdstring required

The unique request identifier provided in the X-GD-RequestId header for tracking and correlation.

Response

OK

clientReferenceNumberstring nullable

Gets or sets the client reference number associated with the order.

emailstring nullable

Gets or sets the email address of the customer who placed the order.

phonestring nullable

Gets or sets the phone number of the customer who placed the order.

companystring nullable

Gets or sets the name of the company associated with the order.

companyIdstring nullable

Gets or sets the unique identifier of the company associated with the order.

deliveryTypestring nullable

Gets or sets the type of delivery for the order (e.g., standard, express).

orderIdentifierstring nullable

Gets or sets the unique identifier for the order.

statusstring nullable

Gets or sets the status of the order (e.g., pending, shipped, delivered).

orderCreatedstring date-time

Gets or sets the date and time when the order was created.

lastChangestring date-time

Gets or sets the date and time when the order was last changed.