create_shipment
Create a shipment for an order using the ShipBob API by specifying the order ID, shipping method, items, and optional fulfillment center ID.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
fulfillmentCenterId | No | Preferred fulfillment center ID | |
items | Yes | Items to ship | |
orderId | Yes | The ID of the order to create a shipment for | |
shippingMethod | Yes | Shipping method to use |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"fulfillmentCenterId": {
"description": "Preferred fulfillment center ID",
"type": "string"
},
"items": {
"description": "Items to ship",
"items": {
"additionalProperties": false,
"properties": {
"orderItemId": {
"description": "Order item ID to ship",
"type": "string"
},
"quantity": {
"description": "Quantity to ship",
"type": "number"
}
},
"required": [
"orderItemId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"orderId": {
"description": "The ID of the order to create a shipment for",
"type": "string"
},
"shippingMethod": {
"description": "Shipping method to use",
"type": "string"
}
},
"required": [
"orderId",
"shippingMethod",
"items"
],
"type": "object"
}