{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/models/advanced-options","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/models/advanced-options","default":false,"active":false,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/models/advanced-options","default":false,"active":true,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Advanced Options Model","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"advanced-options-model","__idx":0},"children":["Advanced Options Model"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data Type"},"children":["Data Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warehouseId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies 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 ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["null"]}," value being returned. *Please see note below"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nonMachinable"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies whether or not the order is non-machinable."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["saturdayDelivery"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies whether or not the order is to be delivered on a Saturday."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["containsAlcohol"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies whether or not the order contains alcohol."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["storeId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ID of store that is associated with the order. If not specified in the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipstation-v1/docs/orders/create-update-order"},"children":["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."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customField1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Field that allows for custom data to be associated with an order. *Please see note below"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customField2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Field that allows for custom data to be associated with an order. *Please see note below"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customField3"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Field that allows for custom data to be associated with an order. *Please see note below"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifies the original source/marketplace of the order. *Please see note below"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mergedOrSplit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns whether or not an order has been merged or split with another order. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read-Only"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mergedIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of numbers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderIds"]},". Each ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderId"]}," identifies an order that was merged with the associated order. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read-Only"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parentId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["null"]},". ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read-Only"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billToParty"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifies which party to bill. Possible values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["my_account, my_other_account (see note below), recipient, third_party"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billTo"]}," values can only be used when ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipstation-v1/docs/orders/create-update-order"},"children":["creating/updating orders"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billToAccount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account number of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billToParty"]},". ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["billTo"]}," values can only be used when creating/updating orders."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billToPostalCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Postal Code of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billToParty"]},". ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["billTo"]}," values can only be used when creating/updating orders."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billToCountryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country Code of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billToParty"]},". ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["billTo"]}," values can only be used when creating/updating orders."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billToMyOtherAccount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["my_other_account"]}," as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billToParty"]}," value, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shippingProviderId"]}," value that is associated with the desired account. Make a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipstation-v1/openapi/carriers/list_carriers"},"children":["List Carriers"]}," call to obtain ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shippingProviderId"]}," values."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["NOTES"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["*Can only be modified via the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipstation-v1/docs/orders/create-update-order"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreateOrder"]}," call"]},". Using the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipstation-v1/openapi/shipments/create_shipment_label"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreateLabelForOrder"]}]}," will default these fields to the values set prior to the call."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipstation-v1/openapi/shipments/create_shipment_label"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreateLabelForOrder"]}]}," will not affect ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["billTo"]}," values. Calls will default ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["billTo"]}," fields to the values set in the order."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["**Setting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billToParty"]}," attribute to \"my_other_account\" is used when wanting to charge a second connected account for the same carrier."]}]}]},"headings":[{"value":"Advanced Options Model","id":"advanced-options-model","depth":1}],"frontmatter":{"seo":{"title":"Advanced Options Model"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipstation-v1/docs/models/advanced-options","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}