input UpdateWholesaleOrderInput

Fields

FieldTypeDescription
order_idString!

Public API order ID for the wholesale order to update.

staging_location_idInt

Public API staging location ID that identifies the related record.

pickup_dateISODateTime

Pickup date in ISO-8601 date or datetime format, returned in UTC when time is included.

preparation_dateISODateTime

Preparation date in ISO-8601 date or datetime format, returned in UTC when time is included.

order_typeString

Order type for this wholesale order.

gs1_labels_requiredBoolean

Whether GS1 carton labels are required for this wholesale order.

trading_partner_idString

Public API trading partner ID that identifies the related record.

trading_partner_nameString

Trading partner name for this wholesale order.

store_location_numberString

Store location number for this wholesale order.

store_address1String

Store address1 for this wholesale order.

store_cityString

Store city for this wholesale order.

store_countryString

Store country for this wholesale order.

store_stateString

Store state for this wholesale order.

store_zipString

Store zip for this wholesale order.

distribution_centerString

Distribution center for this wholesale order.

distribution_center_numberString

Distribution center number for this wholesale order.

purchase_order_typeString

Purchase order type for this wholesale order.

vendorString

Vendor associated with this wholesale order.

vendor_idString

Public API vendor ID that identifies the related record.

requested_delivery_dateISODateTime

Requested delivery date in ISO-8601 date or datetime format, returned in UTC when time is included.

ship_not_before_dateISODateTime

Ship not before date in ISO-8601 date or datetime format, returned in UTC when time is included.

ship_no_later_than_dateISODateTime

Ship no later than date in ISO-8601 date or datetime format, returned in UTC when time is included.

depositor_order_numberString

Depositor order number for this wholesale order.

departmentString

Department for this wholesale order.

department_numberString

Department number for this wholesale order.

divisionString

Division for this wholesale order.

service_levelString

Service level for this wholesale order.

internal_supplier_numberString

Internal supplier number for this wholesale order.

terms_of_saleString

Terms of sale for this wholesale order.

retailer_notesString

Retailer notes for this wholesale order.

quote_numberString

Quote number for this wholesale order.

sales_requirement_codeString

Sales requirement code for this wholesale order.

reference_fieldsJSONObjectScalar

JSON object containing reference fields for this wholesale order.

wholesale_shipping_detailsWholesaleShippingDetailsInput

Wholesale shipping details for this wholesale order.

wholesale_line_items[UpdateWholesaleLineItemInput]

List of wholesale line items for this wholesale order.

shipping_optionWholesaleShippingOptions

Shipping option for this wholesale order.

Referenced By

Example

{
  "order_id": "T3JkZXI6MTIzNA==",
  "staging_location_id": 1234,
  "pickup_date": "2026-07-09T15:30:00Z",
  "preparation_date": "2026-07-09T15:30:00Z",
  "order_type": "retail",
  "gs1_labels_required": true,
  "trading_partner_id": "UmVjb3JkOjEyMzQ=",
  "trading_partner_name": "SO-100045",
  "store_location_number": "STORE-100",
  "store_address1": "123 Fulfillment Ave",
  "store_city": "New York",
  "store_country": "US",
  "store_state": "NY",
  "store_zip": "10001",
  "distribution_center": "DC-East",
  "distribution_center_number": "DC-01",
  "purchase_order_type": "standard",
  "vendor": "Acme Supplies",
  "vendor_id": "VmVuZG9yOjEyMzQ=",
  "requested_delivery_date": "2026-07-09T15:30:00Z",
  "ship_not_before_date": "2026-07-09T15:30:00Z",
  "ship_no_later_than_date": "2026-07-09T15:30:00Z",
  "depositor_order_number": "SO-100045",
  "department": "Apparel",
  "department_number": "42",
  "division": "North",
  "service_level": "standard",
  "internal_supplier_number": "SUP-1001",
  "terms_of_sale": "NET30",
  "retailer_notes": "Customer requested expedited handling.",
  "quote_number": "Q-100045",
  "sales_requirement_code": "STANDARD",
  "reference_fields": {"reference_id": "REF-100045", "notes": "Fragile"},
  "wholesale_shipping_details": {carrier: "ups", method: "ups_ground"},
  "wholesale_line_items": [[{sku: "BLUE-TEE-M", quantity: 2}]],
  "shipping_option": "LTL"
}