Inventory Order Management API Endpoints

Receive Card Inventory Order

This API retrieves a partner's card inventory order.

API Call Structure

POST​ /programs​/{programCode}​/order

Request Body

{
	"clientReferenceNumber": "string",
	"lines": [
		{
			"lineType": "string",
			"productCode": "string",
			"inventoryCode": "string",
			"quantity": 0
		}
	],
	"deliveryAddress": {
		"contactName": "string",
		"addressLine1": "string",
		"addressLine2": "string",
		"city": "string",
		"state": "string",
		"postalCode": "string",
		"country": "string",
		"residential": "string"
	},
	"deliveryType": "string",
	"phone": "string",
	"company": "string",
	"companyId": "string",
	"email": "string"
}

Sample Response Body

{
	"clientReferenceNumber": "string",
	"orderIdentifier": "string",
	"status": "string",
	"orderCreated": "2022-12-24T18:32:09.354Z",
	"responseDetails": {
		"code": 0,
		"subCode": 0,
		"description": "string",
		"url": "string"
	}
}

Obtain Card Inventory Order Status

This API obtains the status of the partner's card inventory order.

API Call Structure

GET ​/programs​/{programCode}​/order​/{orderIdentifier}

Sample Response Body

{
	"clientReferenceNumber": "string",
	"email": "string",
	"phone": "string",
	"company": "string",
	"companyId": "string",
	"lines": [
		{
			"lineType": "string",
			"productCode": "string",
			"inventoryCode": "string",
			"quantity": 0
		}
	],
	"deliveryAddress": {
		"contactName": "string",
		"addressLine1": "string",
		"addressLine2": "string",
		"city": "string",
		"state": "string",
		"postalCode": "string",
		"country": "string",
		"residential": "string"
	},
	"deliveryType": "string",
	"orderIdentifier": "string",
	"status": "string",
	"orderCreated": "2022-12-24T16:58:49.636Z",
	"lastChange": "2022-12-24T16:58:49.636Z",
	"tracking": {
		"provider": "string",
		"trackingNumber": "string"
	},
	"responseDetails": {
		"code": 0,
		"subCode": 0,
		"description": "string",
		"url": "string"
	}
}