input CreateWholesaleOrderInput

Fields

Field	Type	Description
`customer_account_id`	`String`	Use this when you are a 3PL acting on behalf of one of your customers.
`order_number`	`String`	The store's internal order number.
`partner_order_id`	`String`	Storefront-assigned order ID; distinct from Shiphero order_id.
`shop_name`	`String`	Shop name for this order.
`fulfillment_status`	`String`	Status of the order (pending, fulfilled, cancelled, etc).
`order_date`	ISODateTime	Order date in ISO-8601 date or datetime format, returned in UTC when time is included.
`total_tax`	`String`	Monetary amount as a decimal value in the record currency; not cents.
`subtotal`	`String`	DEPRECATED This field will be calculated by Shiphero Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value. Deprecated; see the deprecation reason for current behavior.
`total_discounts`	`String`	Monetary amount as a decimal value in the record currency; not cents.
`total_price`	`String`	DEPRECATED This field will be calculated by Shiphero Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value. Deprecated; see the deprecation reason for current behavior.
`box_name`	`String`	Box name for this order.
`currency`	`String`	ISO 4217 currency code for the monetary values on this order.
`ready_to_ship`	`Boolean`	DEPRECATED This field is no longer being updated and should not be used or relied on Deprecated ready-to-ship flag; this field is no longer updated reliably.
`insurance_amount`	Decimal	Monetary amount as a decimal value in the record currency; not cents.
`shipping_lines`	CreateShippingLinesInput	Shipping lines for this order.
`shipping_address`	CreateOrderAddressInput!	Shipping address details for this order.
`billing_address`	CreateOrderAddressInput	Billing address details for this order.
`third_party_shipper`	ThirdPartyShipperInput	Third-party billing details. If supplied, account_number, zip, and country are required.
`from_name`	`String`	From name for this order.
`note_attributes`	[OrderNoteAttributeInput]	DEPRECATED Not used anymore. Use gift note Legacy name/value note attributes; ignored in favor of gift_note where deprecated.
`tags`	[`String`]	List of tags for this order.
`line_items`	[CreateWholesaleLineItemInput]	List of line items associated with this wholesale order.
`gift_note`	`String`	Gift note for this order.
`gift_invoice`	`Boolean`	Whether this order should use a gift invoice.
`require_signature`	`Boolean`	Whether this order requires a delivery signature.
`adult_signature_required`	`Boolean`	Whether this order requires an adult delivery signature.
`alcohol`	`Boolean`	Whether this order contains alcohol and requires alcohol shipping handling.
`insurance`	`Boolean`	Whether shipping insurance is enabled for this order.
`allow_partial`	`Boolean`	True when this order allows partial; false otherwise.
`allow_split`	`Boolean`	True when this order allows split; false otherwise.
`custom_invoice_url`	`String`	URL for the custom invoice URL resource.
`email`	`String`	Email address for the contact.
`profile`	`String`	Profile for this order.
`packing_note`	`String`	Packing note for this order.
`required_ship_date`	ISODateTime	Required ship date in ISO-8601 date or datetime format, returned in UTC when time is included.
`auto_print_return_label`	`Boolean`	Whether a return label should be printed automatically for this order.
`hold_until_date`	ISODateTime	Hold until date in ISO-8601 date or datetime format, returned in UTC when time is included.
`incoterms`	`String`	Incoterms for this order.
`tax_id`	`String`	Public API tax ID that identifies the related record.
`tax_type`	`String`	Tax type for this order.
`flagged`	`Boolean`	Whether this order is flagged for attention.
`saturday_delivery`	`Boolean`	Whether Saturday delivery is requested for this order.
`ignore_address_validation_errors`	`Boolean`	US addresses are validated and when errors occur the order will have an address hold created. If this flag is set then the error validation is skipped and no address hold is created.
`skip_address_validation`	`Boolean`	When true, address validation is skipped for this order.
`priority_flag`	`Boolean`	Whether this order is marked as priority.
`allocation_priority`	`Int`	Allocation priority as a numeric value.
`holds`	HoldsInput	Holds for this order.
`dry_ice_weight_in_lbs`	`String`	Dry ice weight in lb in pounds.
`ftr_exemption`	Decimal	Foreign Trade Regulations exemption value. Deprecated; use ftr_exemption_value.
`address_is_business`	`Boolean`	Whether the ship-to address is a business address.
`tote_qa`	`Boolean`	Requires users to scan and verify all items from a tote before shipping.
`do_not_print_invoice`	`Boolean`	Whether invoices should be suppressed when printing documents for this order.
`ignore_payment_capture_errors`	`Boolean`	Whether to ignore payment capture errors for this order.
`service_point_id`	`String`	Public API service point ID that identifies the related record.
`partner_source_name`	`String`	Partner source identifier (e.g., web, pos, shopify_draft_order, etc.).
`shipping_option`	WholesaleShippingOptions	Shipping option for this wholesale order.
`staging_location_id`	`Int`	Public API staging location ID that identifies the related record.
`picking_flow`	WholesaleOrderPickingFlow	Picking flow for this wholesale order.
`outbound_progress`	WholesaleOrderOutboundProgress	Outbound progress for this wholesale order.
`pickup_date`	ISODateTime	Pickup date in ISO-8601 date or datetime format, returned in UTC when time is included.
`preparation_date`	ISODateTime	Preparation date in ISO-8601 date or datetime format, returned in UTC when time is included.
`order_type`	`String`	Order type for this wholesale order.
`gs1_labels_required`	`Boolean`	Whether GS1 carton labels are required for this wholesale order.
`trading_partner_id`	`String`	Public API trading partner ID that identifies the related record.
`trading_partner_name`	`String`	Trading partner name for this wholesale order.
`store_location_number`	`String`	Store location number for this wholesale order.
`store_address1`	`String`	Store address1 for this wholesale order.
`store_city`	`String`	Store city for this wholesale order.
`store_country`	`String`	Store country for this wholesale order.
`store_state`	`String`	Store state for this wholesale order.
`store_zip`	`String`	Store zip for this wholesale order.
`distribution_center`	`String`	Distribution center for this wholesale order.
`distribution_center_number`	`String`	Distribution center number for this wholesale order.
`purchase_order_type`	`String`	Purchase order type for this wholesale order.
`vendor`	`String`	Vendor associated with this wholesale order.
`vendor_id`	`String`	Public API vendor ID that identifies the related record.
`requested_delivery_date`	ISODateTime	Requested delivery date in ISO-8601 date or datetime format, returned in UTC when time is included.
`ship_not_before_date`	ISODateTime	Ship not before date in ISO-8601 date or datetime format, returned in UTC when time is included.
`ship_no_later_than_date`	ISODateTime	Ship no later than date in ISO-8601 date or datetime format, returned in UTC when time is included.
`depositor_order_number`	`String`	Depositor order number for this wholesale order.
`department`	`String`	Department for this wholesale order.
`department_number`	`String`	Department number for this wholesale order.
`division`	`String`	Division for this wholesale order.
`service_level`	`String`	Service level for this wholesale order.
`internal_supplier_number`	`String`	Internal supplier number for this wholesale order.
`terms_of_sale`	`String`	Terms of sale for this wholesale order.
`retailer_notes`	`String`	Retailer notes for this wholesale order.
`quote_number`	`String`	Quote number for this wholesale order.
`sales_requirement_code`	`String`	Sales requirement code for this wholesale order.
`reference_fields`	JSONObjectScalar	JSON object containing reference fields for this wholesale order.
`wholesale_shipping_details`	WholesaleShippingDetailsInput	The shipping details to be used to create a new wholesale order.

Referenced By

wholesale_order_create Mutation

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "order_number": "SO-100045",
  "partner_order_id": "SHOPIFY-100045",
  "shop_name": "SO-100045",
  "fulfillment_status": "pending",
  "order_date": "2026-07-09T15:30:00Z",
  "total_tax": "19.99",
  "subtotal": "19.99",
  "total_discounts": "19.99",
  "total_price": "19.99",
  "box_name": "SO-100045",
  "currency": "19.99",
  "ready_to_ship": true,
  "insurance_amount": 19.99,
  "shipping_lines": {title: "Standard Shipping", price: "5.99"},
  "shipping_address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "billing_address": {address1: "123 Billing St", city: "New York", country: "US"},
  "third_party_shipper": "US",
  "from_name": "SO-100045",
  "note_attributes": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "tags": ["priority", "vip"],
  "line_items": [[{sku: "BLUE-TEE-M", quantity: 2}]],
  "gift_note": "Customer requested expedited handling.",
  "gift_invoice": true,
  "require_signature": true,
  "adult_signature_required": true,
  "alcohol": true,
  "insurance": true,
  "allow_partial": true,
  "allow_split": true,
  "custom_invoice_url": "https://example.com/resource",
  "email": "customer@example.com",
  "profile": "default",
  "packing_note": "Customer requested expedited handling.",
  "required_ship_date": "2026-07-09T15:30:00Z",
  "auto_print_return_label": true,
  "hold_until_date": "2026-07-09T15:30:00Z",
  "incoterms": "DAP",
  "tax_id": "UmVjb3JkOjEyMzQ=",
  "tax_type": "19.99",
  "flagged": true,
  "saturday_delivery": true,
  "ignore_address_validation_errors": false,
  "skip_address_validation": false,
  "priority_flag": true,
  "allocation_priority": 1,
  "holds": {operator_hold: true, fraud_hold: false},
  "dry_ice_weight_in_lbs": "1.25",
  "ftr_exemption": 1.5,
  "address_is_business": true,
  "tote_qa": true,
  "do_not_print_invoice": false,
  "ignore_payment_capture_errors": false,
  "service_point_id": "UHVyY2hhc2VPcmRlcjoxMjM0",
  "partner_source_name": "shopify",
  "shipping_option": "LTL",
  "staging_location_id": 1234,
  "picking_flow": "PICK_TO_TOTE",
  "outbound_progress": "NOT_STARTED",
  "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"}
}