mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-07 20:57:47 +00:00
21 KiB
21 KiB
BatchShipment
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
shipment |
components.ShipmentCreateRequest | ✔️ | N/A | |
object_id |
str | ✔️ | Object ID of this batch shipment. Can be used in the remove_shipments endpoint. | e11c95a6788d4ddcaa22f03175838740 |
status |
components.Status | ✔️ | INVALID batch shipments cannot be purchased and will have to be removed, fixed, and added to the batch again.VALID batch shipments can be purchased. Batch shipments with the status TRANSACTION_FAILED were not able to be purchased and the error will be displayed on the message fieldINCOMPLETE 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] | ➖ | Object ID of the carrier account to be used for this shipment (will override batch default) | a4391cd4ab974f478f55dc08b5c8e3b3 |
metadata |
Optional[str] | ➖ | A string of up to 100 characters that can be filled with any additional information you want to attach to the object. |
SHIPMENT #1 |
servicelevel_token |
Optional[str] | ➖ | A token that sets the shipping method for the batch, overriding the batch default. Servicelevel tokens can be found in this list or at this endpoint. |
fedex_ground |
messages |
List[components.ErrorMessage] | ➖ | List of Shipment and Transaction error messages. | |
transaction |
Optional[str] | ➖ | Object ID of the transaction object created for this batch shipment. | 4c33736a67e2450da88b38c42deef6b7 |