> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Shipment

Shipments are not created in the system until an order goes into picking. There may be multiple shipments for one order depending on the overall weight and number of items on the order. Although there may be more than one package for a single shipment, most shipments will have only one package. A packing slip will be printed for each shipment and if multiple packages are required for one shipment they will be linked to the same master tracking number if supported by the carrier.

## Methods

* [shipment.search](#shipment-search)
* [shipment.info](#shipment-info)
* [shipment.update](#shipment-update)

***

## Entity Properties

* [Shipment](#shipment-properties)
* [Shipment Item](#shipment-item-properties)
* [Package](#package-properties)
* [Shipment Track](#track-properties) (deprecated)

***

## `shipment.search`

`shipment.search(null|object $filters, array $options = [], null|string|object $fields = [])`

Retrieve list of shipments by filters. Shipment data can be customized by specifying properties to retrieve.

> [!WARNING]
>
> Some accounts may still receive deprecated shipment status names in `shipment.search` responses because of a compatibility flag from the 2023 package tracking migration. If your integration receives `loaded`, treat it as equivalent to `shipped` and support both the old and new status names. See the [Package Tracking Migration Guide](https://help.shipstream.io/release-notes/package-tracking-migration-guide#statuses) for the full status mapping.

### Parameters

**filters** `null | object`

* `null` - Retrieve list of all shipments.
* `object` - Retrieve list of shipments using specified [Search Filters](https://docs.shipstream.io/merchant-api/search-filters.md).
  Allowed properties for filtering: "shipment\_id", "warehouse\_id", "order\_unique\_id", "order\_ref", "order\_id", "store\_code", "created\_at", "updated\_at", "packed\_at", "status", "shipment\_type".

**options** `null | array`

* `null` - No options will be applied.
* `object` - Apply specified [Search Options](https://docs.shipstream.io/merchant-api/search-options.md).

**fields** `null | string | object`

* `null` - Retrieve only "shipment\_id", "order\_unique\_id", and "order\_ref" properties.
* `string '*'` - Retrieve all properties excluding "shipping\_address", "items", "packages", "tracking\_numbers", and "serial\_number\_data".
* `object` - List of properties to retrieve in addition to "shipment\_id", "order\_unique\_id", and "order\_ref". List may include '\*'.
  Example:

```json theme={null}
["*", "shipping_address", "packages"]
```

See [Shipment Properties](#shipment-properties).

### Return Value

An object with the following properties:

**results** `array`

An array of objects. Each object will contain the specified (or default if no fields parameter was given) [Shipment Properties](#shipment-properties).

**totalCount** `integer`

The total number of shipments matching the given filters. Omitted if `skip_totals` is enabled.

**numPages** `integer`

The total number of pages. Omitted if `skip_totals` is enabled.

### Example Request

```json title="Request" theme={null}
{
    "jsonrpc": 2.0,
    "id": 1234,
    "method": "call",
    "params": [
        "97ca4f4a5cdca59e9dd0fe52e28bf7cf",
        "shipment.search",
        [
            { "status": "picked" },
            { "limit": 1 },
            ["status", "created_at", "updated_at"]
        ]
    ]
}
```

### Example Response

```json title="Response" theme={null}
{
    "jsonrpc": 2.0,
    "id": 1234,
    "result": {
        "results": [
            {
                "shipping_method": "fedex_FEDEX_GROUND",
                "tpb_group_id": null,
                "order_unique_id": "1100000005",
                "order_ref": null,
                "shipment_id": "1100000002",
                "warehouse_id": "1",
                "status": "picked",
                "created_at": "2018-01-26T15:11:08+00:00",
                "updated_at": "2020-03-20T17:01:15+00:00"
            }
        ],
        "totalCount": 28,
        "numPages": 28
    }
}
```

### Example Request (skip\_totals)

```json title="Request" theme={null}
{
    "jsonrpc": 2.0,
    "id": 1234,
    "method": "call",
    "params": [
        "97ca4f4a5cdca59e9dd0fe52e28bf7cf",
        "shipment.search",
        [
            { "status": "picked" },
            { "limit": 1, "skip_totals": 1 },
            ["status", "created_at", "updated_at"]
        ]
    ]
}
```

### Example Response (skip\_totals)

```json title="Response" theme={null}
{
    "jsonrpc": 2.0,
    "id": 1234,
    "result": {
        "results": [
            {
                "shipping_method": "fedex_FEDEX_GROUND",
                "tpb_group_id": null,
                "order_unique_id": "1100000005",
                "order_ref": null,
                "shipment_id": "1100000002",
                "warehouse_id": "1",
                "status": "picked",
                "created_at": "2018-01-26T15:11:08+00:00",
                "updated_at": "2020-03-20T17:01:15+00:00"
            }
        ]
    }
}
```

### Error Codes

| code | message |
| - | - |
| 101 | Invalid filters given. Details in error message. |

***

## `shipment.info`

`shipment.info(string $shipment)`

Retrieve all shipment information.

### Parameters

**shipment** `string`

Shipment ID. Can be retrieved from the order "shipments" property.

### Return Value

Shipment information.

### Example Request

```json title="Request" theme={null}
{
    "jsonrpc": 2.0,
    "id": 1234,
    "method": "call",
    "params": [
        "97ca4f4a5cdca59e9dd0fe52e28bf7cf",
        "shipment.info",
        "100000020"
    ]
}
```

### Example Response

```json title="Response" theme={null}
{
    "jsonrpc": 2.0,
    "id": 1234,
    "error": null,
    "result": 
    {
        "shipment_id": "100000020",
        "warehouse_id": 1,
        "order_unique_id": "10000015",
        "order_ref": "ABC-54321",
        "store_code": "acme",
        "status": "packing",
        "shipment_type": "parcel",
        "total_weight": "13.2300",
        "total_weight_unit": "lb",
        "total_item_weight": "12.1100",
        "total_item_weight_unit": "lb",
        "total_qty": "2.0000",
        "shipped_weight": "13.2300",
        "shipped_weight_unit": "lb",
        "source": "123",
        "tpb_group_id": 1,
        "manifest_courier_code": "fedex",
        "manifest_courier_name": "FedEx",
        "created_at": "2014-07-24T18:51:18+00:00",
        "updated_at": "2014-07-24T18:51:18+00:00",
        "items": [
            {
                "sku": "product2",
                "name": "product2",
                "weight": "12.0500",
                "weight_unit": "lb",
                "qty": "1.0000",
                "qty_picked": "1.0000",
                "qty_shipped": "0.0000",
                "order_item_id": 121,
                "package_data": [
                    {"order_item_id": 121, "label": "Serial Number - 8 Characters", "value": "55285368"}
                ],
                "lot_data": [
                    {"lot_id": 456, "sku": "product2", "lot_number": "83CBC2", "expiration_date": "2021-10-05", "origination_date": "2019-01-23", "qty": "1.0000"}
                ]
            },
            {
                "sku": "product1",
                "name": "product1",
                "weight": "1.2300",
                "weight_unit": "lb",
                "qty": "1.0000",
                "qty_picked": "1.0000",
                "qty_shipped": "1.0000",
                "order_item_id": 122,
                "package_data": [
                    {"order_item_id": 122, "label": "Serial Number - 8 Characters", "value": "55285442"}
                ],
                "lot_data": [
                    {"lot_id": 789, "sku": "product1", "lot_number": "83CCC2", "expiration_date": "2021-10-25", "origination_date": "2019-01-23", "qty": "1.0000"}
                ],
                "ssccs": [
                    {"sscc": "508101336500131005", "package_index": 0}
                ]
            }
        ],
        "packages": [
            {
                "warehouse_id": "1",
                "shipment_id": "1100000061",
                "shipment_status": "packed",
                "status": "packed",
                "carrier": "fedex",
                "created_at": "2014-07-24T18:51:18+00:00",
                "tracking_added_at": "2014-07-24T18:51:18+00:00",
                "shipped_at": "2014-07-24T18:51:18+00:00",
                "delivered_at": "2014-07-24T18:51:18+00:00",
                "weight": "13.2300",
                "weight_unit": "lb",
                "billable_weight": "14",
                "billable_weight_unit": "lb",
                "dimensional_weight_divisor": "139",
                "dimensional_weight_divisor_unit": "in^3/lb",
                "dimensional_weight": "14",
                "rating_weight_unit": "lb",
                "dimensions": {
                    "length": "16.000",
                    "width": "12.000",
                    "height": "8.000"
                },
                "dimension_unit": "in",
                "tracking": [
                    {
                        "number": "800027315160887",
                        "description": "FedEx International Economy",
                        "track_url": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=800027315160887"
                    }
                ],
                "order_items": [
                    {
                        "order_item_id": "122",
                        "order_item_ref": null,
                        "sku": "product1",
                        "quantity": "1.0000"
                    }
                ],
                "package_items": [
                    {
                        "order_item_id": "122",
                        "sku": "product1",
                        "quantity": "1.0000"
                    }
                ],
                "package_data": [
                    {"order_item_id": 121, "label": "Serial Number - 8 Characters", "value": "55285368"},
                    {"order_item_id": 122, "label": "Serial Number - 8 Characters", "value": "55285442"}
                ],
                "serial_number_data": [
                    {
                        "serial_id": "1",
                        "identifier": "123456123456",
                        "sku": "product1",
                        "product_id": "7"
                    }
                ]
            }
        ],
        "tracking_numbers": [
            {
                "carrier": "fedex",
                "description": "FedEx International Economy",
                "number": "800027315160887",
                "date": "2014-07-24T18:51:18+00:00",
                "items": [
                    {"sku": "product1", "quantity": "1.0000" },
                    {"sku": "product2", "quantity": "1.0000" }
                ],
                "weight": "13.2300",
                "weight_unit": "lb"
            }
        ],
        "custom_fields": {
            "freight_broker": { "id": 15, "label": "FreightClub" },
            "hazmat_inspected_by": { "value": 414 }
        }
    }
}
```

### Error Codes

| code | message |
| - | - |
| 100 | Requested shipment does not exist. |

***

## `shipment.update`

`shipment.update (string $shipment, object $shipmentData, object $customFields)`

Update shipment information.

### Parameters

**shipment** `string`

Shipment ID. Can be retrieved from the order "shipments" property.

**shipmentData** `object`

Shipment data.
Allowed properties: source.

**customFields** `object`

Shipment Custom Field Operations (see [Shipment Custom Field Operations](#shipment-custom-field-operations)).

### Shipment Custom Field Operations

An object with an operation name as the key and an object containing the [Shipment Custom Field](#shipment-custom-field)) data for all operations except the `remove` operation. The `remove` operation only requires a list of custom field codes.
Allowed operations: `set`, `add`, `remove`, `add_option`, `remove_option`.

* `set` - Replace all values.
* `add` - Add new fields to existing, replace old values.
* `remove` - Remove only fields specified.
* `add_option` - Multi-selects only. Add an option without unsetting existing options.
* `remove_option` - Multi-selects only. Remove an option without unsetting other options not listed.

### Return Value

`true` if shipment was successfully updated.

### Example Request

```json title="Request" theme={null}
{
    "jsonrpc": 2.0,
    "id": 1234,
    "method": "call",
    "params": [
        "97ca4f4a5cdca59e9dd0fe52e28bf7cf",
        "shipment.update",
        [
            "100000020",
            {
                "source": "123456"
            }
        ]
    ]
}
```

### Example Response

```json title="Response" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "result" : true
}
```

### Error Codes

| code | message |
| - | - |
| 100 | Requested shipment does not exist. |
| 102 | Invalid data given. Details in error message. |

## Entity Properties

### Shipment Properties

**Shipment Properties**

**shipment\_id** `string`

The "Shipment ID" property. This number may appear on the packing slip as the "Packing Slip #".

**warehouse\_id** `integer`

The internal warehouse ID.

**order\_unique\_id** `string`

The "unique\_id" property for the order associated with this shipment.

**order\_ref** `string`

The user-specified order "order\_ref" field.

**store\_code** `string`

The store code used to place the order.

**status** `string`

The "Status" property. Allowed values: new, picking, picked, packing, packed, shipped, canceled, voided. Some accounts may receive the deprecated compatibility value `loaded`, which is equivalent to `shipped`.

**shipment\_type** `string`

The "Shipment Type" property. Allowed values: parcel, freight.

**source** `string`

The "Source" property.

**total\_weight** `string`

The estimated total weight of the shipment including packaging.

**total\_weight\_unit** `string`

The unit of measure used for `total_weight`. See: [Weight Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#weight).

**total\_item\_weight** `string`

The "Total Item Weight" property.

**total\_item\_weight\_unit** `string`

The unit of measure used for `total_item_weight`. See: [Weight Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#weight).

**total\_qty** `string`

The "Total Quantity" property.

**shipped\_weight** `string`

The "Shipped Weight" property.

**shipped\_weight\_unit** `string`

The unit of measure used for `shipped_weight`. See: [Weight Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#weight).

**source** `string`

This field is used for storing association data for integrations.

**tpb\_group\_id** `string`

The Third Party Billing Account Group ID.

**target\_ship\_date** `string`

The date the shipment is intended to be shipped. This is computed based on when the order was "Ready to Ship" and the configured cutoff times for same day shipping.

**scac** `string`

The Standard Carrier Alpha Code.

**manifest\_courier\_code** `string`

The manifest courier code.

**manifest\_courier\_name** `string`

The manifest courier name.

**created\_at** `string`

Date and time when the shipment was created in ISO 8601 format.

**updated\_at** `string`

Date and time when the shipment was last updated in ISO 8601 format.

**packed\_at** `string`

Date and time when all packages were packed in ISO 8601 format.

**shipped\_at** `string`

Date and time when all packages were shipped from the warehouse in ISO 8601 format.

**delivered\_at** `string`

Date and time when all packages were delivered in ISO 8601 format.

**tracking\_added\_at** `string`

Date and time the tracking was added in ISO 8601 format.

**shipping\_address** `object`

Object of [Shipping Address](#address-properties) properties.

**items** `array`

Array of [Shipment Item](#shipment-item-properties) objects.

**packages** `array`

Array of [Package](#package-properties) objects.

**tracking\_numbers** `array`

Array of [Shipment Track](#track-properties) objects. *This field is deprecated. Please use 'packages' instead.*

**custom\_fields** `object`

Object with Custom Fields. See [Shipment Custom Field](#shipment-custom-field).

**retailer\_id** `integer`

The internal ID of the parent order's linked B2B [Retailer](https://docs.shipstream.io/merchant-api/retailer.md), or `null`. Makes the link visible without loading the retailer.

**retailer** `object`

The parent order's linked [Retailer](https://docs.shipstream.io/merchant-api/retailer.md), or `null`. Excluded from `shipment.search` results by default; request it explicitly via the `fields` parameter.

**Retailer**

**id** `integer`

The internal retailer ID.

**code** `string`

The retailer code.

**name** `string`

The retailer name.

**retailer\_ship\_to\_location\_id** `integer`

The internal ID of the parent order's linked [Retailer Ship-To Location](https://docs.shipstream.io/merchant-api/retailer.md#retailer-ship-to-location-properties), or `null`. Makes the link visible without loading the location.

**retailer\_ship\_to\_location** `object`

The parent order's linked retailer ship-to location, or `null`. Excluded from `shipment.search` results by default; request it explicitly via the `fields` parameter.

**Retailer Ship-To Location**

**id** `integer`

The internal ship-to location ID.

**qualifier** `string`

The canonical qualifier scheme for the code. See the [Retailer Ship-To Location](https://docs.shipstream.io/merchant-api/retailer.md#retailer-ship-to-location-properties) allowed values.

**code** `string`

The ship-to location code.

**label** `string`

Optional display label.

**location\_type** `string`

Location type. One of `dc`, `store`, `drop_ship`, `other`.

**mark\_for\_location\_id** `integer`

The internal ID of the parent order's linked mark-for [Retailer Ship-To Location](https://docs.shipstream.io/merchant-api/retailer.md#retailer-ship-to-location-properties) — the final-destination store the cartons are marked for — or `null`. Makes the link visible without loading the location.

**mark\_for\_location** `object`

The parent order's linked mark-for location, or `null`. Unlike `retailer_ship_to_location`, this block carries the location's address fields so integrations can render carton label zones and ASN segments from it. Included by default in `shipment.info`. `shipment.search` omits it by default and from its wildcard; pass `["*", "mark_for_location"]` as the `fields` argument to include it with the other search fields.

**Mark-For Location**

**id** `integer`

The internal location ID.

**qualifier** `string`

The canonical qualifier scheme for the code. See the [Retailer Ship-To Location](https://docs.shipstream.io/merchant-api/retailer.md#retailer-ship-to-location-properties) allowed values.

**code** `string`

The location code, for example the retailer's store number.

**label** `string`

Optional display label.

**location\_type** `string`

Location type. One of `dc`, `store`, `drop_ship`, `other`.

**company** `string`

Company name at the location.

**street** `string`

Street address.

**city** `string`

City.

**region** `string`

Region/state. When the location stores only a numeric region reference (`region_id`), the region code (for example `TX`) is returned so labels and documents keep the state.

**postcode** `string`

Postal code.

**country\_id** `string`

Two-letter country code.

**telephone** `string`

Phone number.

**email** `string`

Email address.

### Shipment Item Properties

**Shipment Item Properties**

**sku** `string`

The "SKU" property.

**name** `string`

The "Name" property.

**weight** `string`

The "Weight" property.

**weight\_unit** `string`

The unit of measure used for `weight`. See: [Weight Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#weight).

**qty** `string`

The "Quantity" property.

**qty\_picked** `string`

The "Picked" quantity.

**qty\_shipped** `string`

The "Shipped" quantity.

**qty\_cancel\_requested** `string`

The "Cancel Requested" quantity. Denotes the quantity to be cancelled if cancellation request is confirmed.

**qty\_canceled** `string`

The "Canceled" quantity.

**order\_item\_id** `integer`

The internal order item ID.

**package\_data** `array`

The "Package Data" property.

**lot\_data** `array`

The Lot Data for the Shipment Item.

**lot\_data\[].lot\_id** `integer`

The internal Lot ID.

**lot\_data\[].sku** `string`

The SKU of the Product assigned to the Lot. This may differ from the Shipment Item `sku` for BOM and quantity-type workflows.

**lot\_data\[].lot\_number** `string`

The Lot Number.

**lot\_data\[].expiration\_date** `string`

The Lot expiration date.

**lot\_data\[].origination\_date** `string`

The Lot origination date.

**lot\_data\[].qty** `string`

The quantity assigned to the Lot.

**ssccs** `array`

The item SSCCs.

### Package Properties

**Package Properties**

**warehouse\_id** `string`

The ID of the warehouse associated with the package.

**status** `string`

The "Status" property. Allowed values: packing, tracking\_required, packed, manifested, shipped, delivered.

**shipment\_id** `string`

The "Shipment ID" property. This number may appear on the packing slip as the "Packing Slip #" and is used for the Shipment API calls.

**shipment\_status** `string`

The "Shipment Status" property. Allowed values: new, picking, picked, packing, packed, shipped, canceled, voided.

**carrier** `string`

Carrier code.

**shipped\_at** `string`

Date and time when the package was shipped from the warehouse in ISO 8601 format.

**delivered\_at** `string`

Date and time when the package was delivered in ISO 8601 format.

**weight** `string`

The weight of the package.

**weight\_unit** `string`

The unit of measure used for `weight`. See: [Weight Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#weight).

**billable\_weight** `integer`

The billable weight of the package.

**billable\_weight\_unit** `string`

The unit of measure used for `billable_weight`. See: [Weight Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#weight).

**dimensional\_weight\_divisor** `string`

The dimensional weight divisor of the package.

**dimensional\_weight\_divisor\_unit** `string`

The dimensional weight divisor unit. See: [Dimensional Divisor Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#dimensional-divisor).

**dimensional\_weight** `string`

The dimensional weight of the package.

**rating\_weight\_unit** `string`

The unit of measure used for `dimensional_weight`. See: [Weight Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#weight).

**dimensions** `object`

The `length`, `width`, and `height` of the package.

**dimension\_unit** `string`

The unit of measure used for `length`, `width`, and `height` in `dimensions`. See: [Length Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#length).

**sscc** `string`

The Serial Shipping Container Code.

**tracking** `array`

An array of tracking objects. The "number" property contains the tracking number. The "description" property contains the shipping method name. The "track\_url" property will contain a URL to the carrier's tracking page if applicable.

**order\_items** `array`

An array of order items contained in the package. These items may be different from those in "package\_items" if the order was fulfilled using a Bill of Materials. "order\_item\_id" is the unqiue identifier for the order item. "order\_item\_ref" is an optional user supplied reference for the order item. "sku" is the order item's SKU. "quantity" is the quantity of the order item in the package.

**package\_items** `array`

An array of items contained in the package. These items may be different from those in "order\_items" if the order was fulfilled using a Bill of Materials. "order\_item\_id" is the unqiue identifier of the related order item. "sku" is the package item's SKU. "quantity" is the quantity of the item in the package.

**package\_data** `array`

The "Package Data" property.

**packaging** `array`

The "Packaging" property.

**serial\_number\_data** `array`

Array of serial numbers. See [Serial Number properties](#serial-number-properties).

### Shipment Track Properties

**Shipment Track Properties**

**carrier** `string`

The carrier code.

**description** `string`

The method description (with the carrier name).

**number** `string`

The carrier's tracking number.

**date** `string`

The date and time the tracking number was created.

**items** `array`

SKUs and quantities of the related package items.

**weight** `string`

The weight of the package.

**weight\_unit** `string`

The unit of measure used for `weight`. See: [Weight Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#weight).

### Serial Number Properties

**Serial Number Properties**

**serial\_id** `string`

The "Serial ID" property.

**identifier** `string`

The unique identifier of the serial number.

**sku** `string`

The SKU of the product associated with the serial number.

**product\_id** `string`

The ID of the product associated with the serial number.

### Shipment Custom Field

An object with a Custom Field code as the key and the Custom Field data as the value. The value format depends on the Custom Field input type.

`"custom_fields": { ... }`

To find out what fields are available see [Shipment Custom Fields](https://docs.shipstream.io/merchant-api/shipment-custom-field.md) — `shipment_custom_field.list`

**Shipment Custom Field**

**text** `object`

Maximum number of characters is 1024.

```json theme={null}
{ "main_sku" : { "value" : "product2" } }
```

**multiline-text** `object`

```json theme={null}
{ "shipment_details" : { "value" : "Long multiline 
shipment details 
here." } }
```

**number** `object`

```json theme={null}
{ "number_of_skus" : { "value" : 5 } }
```

```json theme={null}
{ "length_and_girth" : { "value" : 54.25 } }
```

**currency** `object`

```json theme={null}
{ "cost_of_goods" : { "amount" : 105.95 } }
```

**select** `object`

Select input type data must be an object with `label` or `id` key or both.

```json theme={null}
{ "claim_reason" : { "id" : 13 } }
```

Preferred. An option is set by `id`.

```json theme={null}
{ "claim_reason" : { "label" : "Damaged in shipping" } }
```

An option is set by `label`.

```json theme={null}
{ "claim_reason" : { "id" : 13, "label" : "Damaged in shipping" } }
```

An option is set by `id` and `label`. The `id` and the `label` must refer to the same option.

**multiselect** `array`

Multi-select input type data must be an array of objects with `label` or `id` key or both.

```json theme={null}
{ "claim_reasons" : [ { "id" : 13 }, { "id" : 14 } ] }
```

Preferred. An option is set by `id`.

```json theme={null}
{ "claim_reasons" : [ { "label" : "Damaged in shipping" }, { "label" : "Did not fit" } ] }
```

An option is set by `label`.

```json theme={null}
{ "claim_reasons" : [ { "id" : 13, "label" : "Damaged in shipping" }, { "id" : 14, "label" : "Did not fit" } ] }
```

An option is set by `id` and `label`. The `id` and the `label` must refer to the same option.

**boolean** `object`

```json theme={null}
{ "allow_mailer" : { "value" : true } }
```

**date** `object`

Must be in `Y-m-d` format.

```json theme={null}
{ "desired_delivery_date" : { "value" : "2023-01-23" } }
```

**client-user** `object`

Must be a client user id.

```json theme={null}
{ "created_by" : { "value" : 5 } }
```

**admin-user** `object`

Must be an admin user id.

```json theme={null}
{ "created_by" : { "value" : 7 } }
```

**email** `object`

Must be a valid email address. Maximum number of characters is 1024.

```json theme={null}
{ "custom_email" : { "value" : "john.doe@example.com" } }
```

**url** `object`

Must be a valid URL. Maximum number of characters is 1024.

```json theme={null}
{ "documentation_url" : { "value" : "https://example.com" } }
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.