Create a new shipment.
POST
/shipments
201Description
If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
Request Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ID | string | --- | 100 characters | --- | ||
| BuyerID | string | --- | --- | --- | ||
| Shipper | string | --- | --- | --- | ||
| DateShipped | string | date-time | --- | --- | ||
| DateDelivered | string | date-time | --- | --- | ||
| TrackingNumber | string | --- | 3000 characters | --- | ||
| Cost | number | float | --- | --- | ||
| OwnerID | string | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||
| Account | string | --- | --- | --- | ||
| FromAddressID | string | --- | --- | --- | ||
| ToAddressID | string | --- | --- | --- | ||
Response Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ID | string | --- | 100 characters | --- | ||
| BuyerID | string | --- | --- | --- | ||
| Shipper | string | --- | --- | --- | ||
| DateShipped | string | date-time | --- | --- | ||
| DateDelivered | string | date-time | --- | --- | ||
| TrackingNumber | string | --- | 3000 characters | --- | ||
| Cost | number | float | --- | --- | ||
| OwnerID | string | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||
| Account | string | --- | --- | --- | ||
| FromAddressID | string | --- | --- | --- | ||
| ToAddressID | string | --- | --- | --- | ||
| FromAddress | Read Only | object | --- | --- | --- | |
| ToAddress | Read Only | object | --- | --- | --- | |
Create a new shipment.
POST
/shipments
201Description
If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
Request Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ID | string | --- | 100 characters | --- | ||
| BuyerID | string | --- | --- | --- | ||
| Shipper | string | --- | --- | --- | ||
| DateShipped | string | date-time | --- | --- | ||
| DateDelivered | string | date-time | --- | --- | ||
| TrackingNumber | string | --- | 3000 characters | --- | ||
| Cost | number | float | --- | --- | ||
| OwnerID | string | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||
| Account | string | --- | --- | --- | ||
| FromAddressID | string | --- | --- | --- | ||
| ToAddressID | string | --- | --- | --- | ||
Response Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ID | string | --- | 100 characters | --- | ||
| BuyerID | string | --- | --- | --- | ||
| Shipper | string | --- | --- | --- | ||
| DateShipped | string | date-time | --- | --- | ||
| DateDelivered | string | date-time | --- | --- | ||
| TrackingNumber | string | --- | 3000 characters | --- | ||
| Cost | number | float | --- | --- | ||
| OwnerID | string | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||
| Account | string | --- | --- | --- | ||
| FromAddressID | string | --- | --- | --- | ||
| ToAddressID | string | --- | --- | --- | ||
| FromAddress | Read Only | object | --- | --- | --- | |
| ToAddress | Read Only | object | --- | --- | --- | |