Advanced Options Model
Name | Data Type | Description |
---|---|---|
warehouseId |
number | Specifies the warehouse where to the order is to ship from. If the order was fulfilled using a fill provider, no warehouse is attached to these orders and will result in a null value being returned. *Please see note below |
nonMachinable |
boolean | Specifies whether the order is non-machinable. |
saturdayDelivery |
boolean | Specifies whether the order is to be delivered on a Saturday. |
containsAlcohol |
boolean | Specifies whether the order contains alcohol. |
storeId |
number | ID of store that is associated with the order. If not specified in the CreateOrder call either to create or update an order, ShipStation will default to the first manual store on the account. Can only be specified during order creation. |
customField1 |
string | Field that allows for custom data to be associated with an order. *Please see note below |
customField2 |
string | Field that allows for custom data to be associated with an order. *Please see note below |
customField3 |
string | Field that allows for custom data to be associated with an order. *Please see note below |
source |
string | Identifies the original source/marketplace of the order. *Please see note below |
mergedOrSplit |
boolean | Read-Only: Returns whether or not an order has been merged or split with another order. Read Only |
mergedIds |
number[] | Read-Only: Array of orderIds. Each orderId identifies an order that was merged with the associated order. Read Only |
parentId |
number | Read-Only: If an order has been split, it will return the Parent ID of the order with which it has been split. If the order has not been split, this field will return null. Read Only |
billToParty |
string | Identifies which party to bill. Possible values: "my_account", "my_other_account" (see note below), "recipient", "third_party". billTo values can only be used when creating/updating orders. |
billToAccount |
string | Account number of billToParty. billTo values can only be used when creating/updating orders. |
billToPostalCode |
string | Postal Code of billToParty. billTo values can only be used when creating/updating orders. |
billToCountryCode |
string | Country Code of billToParty. billTo values can only be used when creating/updating orders. |
billToMyOtherAccount |
string | When using my_other_account billToParty value, the shippingProviderId value associated with the desired account. Make a List Carriers call to obtain shippingProviderId values. |
NOTES:
- *Can only be modified via the CreateOrder call. CreateLabelForOrder will default these fields to the values set prior to the call.
- CreateLabelForOrder will not affect billTo values. Calls will default billTo fields to the values set in the order.
- **Setting "billToParty" attribute to "my_other_account" is used when wanting to charge a second connected account for the same carrier.