Create a new shipment.
Description
If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessShipmentAdmin
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 | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| ID | Read Only | string | --- | 100 characters | --- | | | DateCreated | Read Only | string | date-time | --- | --- | | | CompanyName | Read Only | string | --- | 100 characters | --- | | | FirstName | Read Only | string | --- | 100 characters | --- | | | LastName | Read Only | string | --- | 100 characters | --- | | | Street1 | Read Only | string | --- | 100 characters | --- | | | Street2 | Read Only | string | --- | 100 characters | --- | | | City | Read Only | string | --- | 100 characters | --- | | | State | Read Only | string | --- | 100 characters | --- | | | Zip | Read Only | string | --- | 100 characters | --- | | | Country | Read Only | string | --- | 2 characters | --- | | | Phone | Read Only | string | --- | 100 characters | --- | | | AddressName | Read Only | string | --- | 100 characters | --- | | | xp | Read Only | object | --- | --- | --- | |
|
| ToAddress | Read Only | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| ID | Read Only | string | --- | 100 characters | --- | | | DateCreated | Read Only | string | date-time | --- | --- | | | CompanyName | Read Only | string | --- | 100 characters | --- | | | FirstName | Read Only | string | --- | 100 characters | --- | | | LastName | Read Only | string | --- | 100 characters | --- | | | Street1 | Read Only | string | --- | 100 characters | --- | | | Street2 | Read Only | string | --- | 100 characters | --- | | | City | Read Only | string | --- | 100 characters | --- | | | State | Read Only | string | --- | 100 characters | --- | | | Zip | Read Only | string | --- | 100 characters | --- | | | Country | Read Only | string | --- | 2 characters | --- | | | Phone | Read Only | string | --- | 100 characters | --- | | | AddressName | Read Only | string | --- | 100 characters | --- | | | xp | Read Only | object | --- | --- | --- | |
|