Docs
Add Line Item Group
POST /orders/{orderId}/groups
POST
/orders/{orderId}/groupsRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Adds a new line item group to an order. Groups organise line items and can optionally carry their own delivery schedule and address, overriding the order-level delivery details.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| orderId | Guid | Required | The ID of the order. Replace `{{orderId}}` in the URL. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Group display name. |
| notes | string | Optional | Group-level notes. |
| isDelivery | bool | Required | Whether this group has its own delivery details. |
| startDateTime | DateTime | Required | Group start date/time (ISO 8601). |
| endDateTime | DateTime | Required | Group end date/time (ISO 8601). |
| deliveryInformation | Delivery | Optional | Group-level delivery address. Required when `isDelivery` is `true`. Pass `null` otherwise. |
| deliveryInformation.name | string | Optional | Delivery contact name. |
| deliveryInformation.company | string | Optional | Company name. |
| deliveryInformation.email | string | Optional | Email. |
| deliveryInformation.phone | string | Optional | Phone. |
| deliveryInformation.address | string | Optional | Street address. |
| deliveryInformation.city | string | Optional | City. |
| deliveryInformation.state | string | Optional | State/province. |
| deliveryInformation.country | string | Optional | Country. |
| deliveryInformation.postalCode | string | Optional | Postal/ZIP code. |
Response
Returns 201 Created with an empty body on success.