create_order
Initiate order creation by specifying reference ID, recipient details, and order items. Integrates with ShipBob API to manage e-commerce fulfillment efficiently.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | Order items | |
| orderNote | No | Note for the order | |
| recipient | Yes | Shipping address information | |
| referenceId | Yes | Your reference ID for the order | |
| shippingMethod | No | Preferred shipping method |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"items": {
"description": "Order items",
"items": {
"additionalProperties": false,
"properties": {
"productId": {
"description": "ShipBob product ID",
"type": "string"
},
"quantity": {
"description": "Quantity of the product",
"type": "number"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"orderNote": {
"description": "Note for the order",
"type": "string"
},
"recipient": {
"additionalProperties": false,
"description": "Shipping address information",
"properties": {
"address1": {
"description": "Address line 1",
"type": "string"
},
"address2": {
"description": "Address line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country code (e.g., US)",
"type": "string"
},
"email": {
"description": "Email address",
"type": "string"
},
"name": {
"description": "Recipient's full name",
"type": "string"
},
"phone": {
"description": "Phone number",
"type": "string"
},
"state": {
"description": "State/Province",
"type": "string"
},
"zipCode": {
"description": "Zip/Postal code",
"type": "string"
}
},
"required": [
"name",
"address1",
"city",
"state",
"zipCode",
"country"
],
"type": "object"
},
"referenceId": {
"description": "Your reference ID for the order",
"type": "string"
},
"shippingMethod": {
"description": "Preferred shipping method",
"type": "string"
}
},
"required": [
"referenceId",
"recipient",
"items"
],
"type": "object"
}