---
title: "Submit a card inventory order request."
method: POST
path: "/programs/{programCode}/order"
tags: ["Order"]
---

# Submit a card inventory order request.

`POST /programs/{programCode}/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>

 ****** 
***Inventory Management***
<table><thead><tr><th>Group</th><th>Property</th><th>Required</th><th>Constraint/Scenario</th><th>HttpStatus</th><th>Code</th><th>Sub Code</th><th>Description</th></tr></thead><tbody><tr><td></td><td>clientReferenceNumber</td><td>Y</td><td>&gt;= 2 characters and &lt;= 40 characters</td><td>400</td><td>400</td><td>Required: 6021,Invalid: 6022</td><td>Unique string sent by partner to identify the request</td></tr><tr><td></td><td>email</td><td>Y</td><td>if provided valid email with max 255 char</td><td>400</td><td>400</td><td>6003</td><td></td></tr><tr><td></td><td>phone</td><td>Y</td><td>if provided, 10 digits</td><td>400</td><td>1040</td><td>6004</td><td></td></tr><tr><td></td><td>company</td><td>N</td><td>If provided, &gt;= 2 characters and &lt;= 40 characters</td><td>400</td><td>400</td><td>6030</td><td></td></tr><tr><td></td><td>companyId</td><td>N</td><td>Is Required if company is provided, &gt;= 2 characters and &lt;= 40 characters</td><td>400</td><td>400</td><td>6031</td><td></td></tr><tr><td></td><td>deliveryType</td><td>Y</td><td></td><td>400</td><td>600</td><td>Required: 6001,Invalid: 6002</td><td>Options: Reg, Onn, Pse, Rush</td></tr><tr><td>lines</td><td>lineType</td><td>Y</td><td>Must be "Plastic"</td><td>400</td><td>600</td><td>Required: 6041,Invalid: 6042</td><td>Options: Plastic, Blank</td></tr><tr><td></td><td>productCode</td><td>Y</td><td>Must be Ceridian GPR product code</td><td>400</td><td>1000</td><td>Required: 6051, Invalid: 6052</td><td>Invalid product code for program</td></tr><tr><td></td><td>inventoryCode</td><td>Y</td><td>&gt;=2 and &lt;=40</td><td>400</td><td>6000</td><td>Required: 6061,Invalid: 6062</td><td></td></tr><tr><td></td><td>quantity</td><td>Y</td><td>&gt;=10 and &lt;=10000</td><td>400</td><td>400</td><td>Required: 6081, Invalid: 6082</td><td></td></tr><tr><td>deliveryAddress</td><td>contactName</td><td>Y</td><td>&gt;= 2 characters and &lt;=35 characters</td><td>400</td><td>400</td><td>Required: 6101,Invalid: 6102</td><td>Contact receiving the shipment</td></tr><tr><td></td><td>addressLine1</td><td>Y</td><td>&gt;= 2 characters and &lt;= 30 characters</td><td>400</td><td>400</td><td>Required: 6111,Invalid: 6112</td><td></td></tr><tr><td></td><td>addressLine2</td><td>N</td><td>&lt;= 30 characters</td><td>400</td><td>400</td><td>6121</td><td></td></tr><tr><td></td><td>city</td><td>Y</td><td>&lt;= 25 characters</td><td>400</td><td>400</td><td>Required: 6131, Invalid: 6132</td><td></td></tr><tr><td></td><td>state</td><td>Y</td><td>Must be two characters</td><td>400</td><td>400</td><td>Required: 6141, Invalid: 6142</td><td></td></tr><tr><td></td><td>postalCode</td><td>Y</td><td>Must be 5 digits only</td><td>400</td><td>400</td><td>Required: 6151, Invalid: 6152</td><td></td></tr><tr><td></td><td>country</td><td>Y</td><td>Must be 3 characters</td><td>400</td><td>600</td><td>Required: 6161, Invalid: 6162</td><td>must be USA</td></tr><tr><td></td><td>residential</td><td>Y</td><td>Must be 1 character</td><td>400</td><td>600</td><td>Required: 6171, Invalid: 6172</td><td>Must be Y or N</td></tr></tbody></table>

## Path parameters

- `programCode` string, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- PostOrderRequest — Represents a request to post a new order, including client reference, order lines, delivery details, and contact information. Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.
  - `clientReferenceNumber` string, required — Required. The unique client reference number for the order. Used for tracking and correlation of the order in client systems.
  - `lines` Line[], required — Required. The list of order lines, each representing a product or item in the order.
    - `lineType` string, required — Gets or sets the type of the line.
    - `productCode` string, required — Gets or sets the product code associated with the line.
    - `inventoryCode` string, required — Gets or sets the inventory code for the line.
    - `quantity` integer, required — Gets or sets the quantity for the line.
  - `deliveryAddress` DeliveryAddress, required — Represents a delivery address including contact information and location details.
    - `contactName` string, required — Gets or sets the name of the contact person for the delivery.
    - `addressLine1` string, required — Gets or sets the first line of the delivery address.
    - `addressLine2` string, required — Gets or sets the second line of the delivery address.
    - `city` string, required — Gets or sets the city of the delivery address.
    - `state` string, required — Gets or sets the state or province of the delivery address.
    - `postalCode` string, required — Gets or sets the postal code of the delivery address.
    - `country` string, required — Gets or sets the country of the delivery address.
    - `residential` string, nullable — Gets or sets a value indicating whether the address is residential.
  - `deliveryType` string, required — Required. The type of delivery requested (e.g., standard, express).
  - `phone` string, required — Required. The contact phone number for the order.
  - `company` string, required — Required. The name of the company placing the order.
  - `companyId` string, required — Required. The unique identifier for the company placing the order.
  - `email` string, required — Required. The contact email address for the order.

## Response `200`

OK

- PostOrderResponse — Represents the response returned after posting an order in the order management API. Inherits standard response metadata and order details from Gd.Bos.DataTransfer.Response.OrderManagement.Models.OrderResponseBase. Used to provide feedback about the outcome of a post order operation, including identifiers, status, and response details.
  - `clientReferenceNumber` string, nullable — Gets or sets the client reference number associated with the order. Used to correlate the order with the client's internal systems.
  - `orderIdentifier` string, nullable — Gets or sets the unique identifier for the order. Used to track and reference the order within the system.
  - `status` string, nullable — Gets or sets the status of the order. Indicates the current state of the order (e.g., "Pending", "Completed", "Cancelled").
  - `orderCreated` string, date-time, nullable — Gets or sets the date and time when the order was created. Nullable; may be omitted if not available.
  - `responseDetails` ResponseDetails — Represents the details of a response in the order management system.
    - `code` integer — Gets or sets the main response code.
    - `subCode` integer — Gets or sets the sub-code providing additional response information.
    - `description` string, nullable — Gets or sets the description of the response.
    - `url` string, nullable — Gets or sets the URL associated with the response.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)