mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-09 04:21:27 +00:00
15 lines
21 KiB
Markdown
15 lines
21 KiB
Markdown
# BatchShipment
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `shipment` | [components.ShipmentCreateRequest](../../models/components/shipmentcreaterequest.md) | :heavy_check_mark: | N/A | |
|
|
| `object_id` | *str* | :heavy_check_mark: | Object ID of this batch shipment. Can be used in the remove_shipments endpoint. | e11c95a6788d4ddcaa22f03175838740 |
|
|
| `status` | [components.Status](../../models/components/status.md) | :heavy_check_mark: | `INVALID` batch shipments cannot be purchased and will have to be removed, fixed, and added to the batch again.<br><br/>`VALID` batch shipments can be purchased. <br><br/>Batch shipments with the status `TRANSACTION_FAILED` were not able to be purchased and the error will be displayed on the message field<br> <br/>`INCOMPLETE` batch shipments have an issue with the Address and will need to be removed, fixed, and added to the batch again. | INVALID |
|
|
| `carrier_account` | *Optional[str]* | :heavy_minus_sign: | Object ID of the carrier account to be used for this shipment (will override batch default) | a4391cd4ab974f478f55dc08b5c8e3b3 |
|
|
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you want <br/>to attach to the object. | SHIPMENT #1 |
|
|
| `servicelevel_token` | *Optional[str]* | :heavy_minus_sign: | A token that sets the shipping method for the batch, overriding the batch default. <br/>Servicelevel tokens can be found <a href="#tag/Service-Levels">in this list</a> <br/>or <a href="#operation/ListCarrierAccounts">at this endpoint</a>. | fedex_ground |
|
|
| `messages` | List[[components.ErrorMessage](../../models/components/errormessage.md)] | :heavy_minus_sign: | List of Shipment and Transaction error messages. | |
|
|
| `transaction` | *Optional[str]* | :heavy_minus_sign: | Object ID of the transaction object created for this batch shipment. | 4c33736a67e2450da88b38c42deef6b7 | |