Skip to content
Last updated

Advanced Options Model

NameData TypeDescription
warehouseIdnumberSpecifies the warehouse where the order is to ship from. If the order was fulfilled using a fill provider, no warehouse is attached to these orders and this will result in a null value being returned. *Please see note below
nonMachinablebooleanSpecifies whether or not the order is non-machinable.
saturdayDeliverybooleanSpecifies whether or not the order is to be delivered on a Saturday.
containsAlcoholbooleanSpecifies whether or not the order contains alcohol.
storeIdnumberID 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.
customField1stringField that allows for custom data to be associated with an order. *Please see note below
customField2stringField that allows for custom data to be associated with an order. *Please see note below
customField3stringField that allows for custom data to be associated with an order. *Please see note below
sourcestringIdentifies the original source/marketplace of the order. *Please see note below
mergedOrSplitbooleanReturns whether or not an order has been merged or split with another order. Read-Only
mergedIdsArray of numbersArray of orderIds. Each orderId identifies an order that was merged with the associated order. Read-Only
parentIdnumberIf 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
billToPartystringIdentifies 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.
billToAccountstringAccount number of billToParty. billTo values can only be used when creating/updating orders.
billToPostalCodestringPostal Code of billToParty. billTo values can only be used when creating/updating orders.
billToCountryCodestringCountry Code of billToParty. billTo values can only be used when creating/updating orders.
billToMyOtherAccountstringWhen using my_other_account as the billToParty value, the shippingProviderId value that is associated with the desired account. Make a List Carriers call to obtain shippingProviderId values.

NOTES:

  • *Can only be modified via the CreateOrder call. Using the 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.