| Time | Status | User Agent |  |
| :-- | :-- | :-- | :-- |
| Make a request to see history. |

#### URL Expired

The URL for this request expired after 30 days.

### Shipment Planning Information

#### Request Parameters

| Parameter                      | Type       | Description                                                                                                            |
| ------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------- |
| `requestDateOverride`          | date-time  | Overrides the requestDate to a specific date & time from which the ship by and drop by date are calculated. ISO 8601 format  |
| `desiredDeliveryDate`          | string     | The string representation of either an ISO-8601 date or a LocalDate: yyyy-mm-dd. The date on which you want the shipment delivered.|    
| `businessDaysOfTransit`       | int32      | An integer number of business days by which the shipment must be delivered. Used as an alternative to desiredDeliveryDate. |
| `mustShipByDate`              | date       | A date value specifying when the shipment needs to be shipped by. Mutually exclusive with `mustShipByBusinessDays` and `mustShipByCalendarDays` |
| `mustShipByBusinessDays`      | int32      | An integer number of business days by which the shipment must be shipped. Mutually exclusive with `mustShipByDate` and `mustShipByCalendarDays` |
| `mustShipByCalendarDays`      | int32      | An integer number of calendar days by which the shipment must be shipped. Mutually exclusive with `mustShipByDate` and `mustShipByBusinessDays` |
| `deliveryWindowDays`          | int32      | An integer number of days before the `desiredDeliveryDate` that defines the earliest acceptable delivery date. Optional.|
| `deliveryWindowDaysType`      | string     | The type of days to use when calculating the delivery window: `BUSINESS` for business days, `CALENDAR` for calendar days.|
| `desiredDeliveryDateOptions`   | object     | Options for how the system will use the `desiredDeliveryDate`.                                                                  |

#### Shipment Parameters

| Parameter                  | Type     | Description                                                                                    |
| --------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
| `referenceIdentifier`       | string   | Reference external identifier used for reporting purposes.                                      |
| `partnerReferenceIdentifier` | string   | Reference external identifier explicitly provided by the partner. Used for reporting purposes.    |
| `partnerReferenceIdentifier2` | string   | Secondary reference external identifier explicitly provided by the partner. Used for reporting purposes. |
| `referenceIdentifiers`      | array of objects | Reference external identifiers that are used for reporting purposes.                         |
| `shipmentTags`             | array of strings | Free-form list of shipment tags for this planning request.                                   |
| `options`                  | object   | Additional options for the shipment.                                                            |
| `customerCountryCode`      | string   | Country code of the customer.                                                                   |
| `customerPostalCode`       | string   | Postal code of the customer.                                                                    |
| `X-DELEGATED-PARTNER-ID`   | string   | Partner identifier for the request.                                                             |

### API Response

| Status Code | Description                                      |
| ----------- | ------------------------------------------------ |
| `200`       | Shipment Planning successfully calculated.       |
| `204`       | No Shipment Planning result available.            |
| `400`       | Invalid inputs were provided.                     |
| `403`       | Not authenticated / authorized via OAuth.        |

### Example API Request

```bash
curl --request POST \
     --url https://api.shipium.com/api/v1/deliveryexperience/shipmentPlanning \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

### Try It!

You can start a request and see the response here!