input CreateWholesaleOrderInput

Fields

FieldTypeDescription
customer_account_idString

Use this when you are a 3PL acting on behalf of one of your customers

order_numberString

The store's internal order number

partner_order_idString
shop_nameString
fulfillment_statusString

Status of the order (pending, fulfilled, cancelled, etc)

order_dateISODateTime
total_taxString
subtotalStringDEPRECATED This field will be calculated by Shiphero
total_discountsString
total_priceStringDEPRECATED This field will be calculated by Shiphero
box_nameString
currencyString
ready_to_shipBooleanDEPRECATED This field is no longer being updated and should not be used or relied on
insurance_amountDecimal
shipping_linesCreateShippingLinesInput
shipping_addressCreateOrderAddressInput!
billing_addressCreateOrderAddressInput
from_nameString
note_attributes[OrderNoteAttributeInput]DEPRECATED Not used anymore. Use gift note
tags[String]
line_items[CreateWholesaleLineItemInput]
gift_noteString
gift_invoiceBoolean
require_signatureBoolean
adult_signature_requiredBoolean
alcoholBoolean
insuranceBoolean
allow_partialBoolean
allow_splitBoolean
custom_invoice_urlString
emailString
profileString
packing_noteString
required_ship_dateISODateTime
auto_print_return_labelBoolean
hold_until_dateISODateTime
incotermsString
tax_idString
tax_typeString
flaggedBoolean
saturday_deliveryBoolean
ignore_address_validation_errorsBoolean

US addresses are be 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_validationBoolean

Not address validation will be performed

priority_flagBoolean
allocation_priorityInt
holdsHoldsInput
dry_ice_weight_in_lbsString
ftr_exemptionDecimal
address_is_businessBoolean
tote_qaBoolean

Requires users to scan and verify all items from a tote before shipping

do_not_print_invoiceBoolean
ignore_payment_capture_errorsBoolean
partner_source_nameString

Partner source identifier (e.g., web, pos, shopify_draft_order, etc.)

shipping_optionWholesaleShippingOptions
staging_location_idInt
picking_flowWholesaleOrderPickingFlow
outbound_progressWholesaleOrderOutboundProgress
pickup_dateISODateTime
preparation_dateISODateTime
order_typeString
gs1_labels_requiredBoolean
trading_partner_idString
trading_partner_nameString
store_location_numberString
store_address1String
store_cityString
store_countryString
store_stateString
store_zipString
distribution_centerString
distribution_center_numberString
purchase_order_typeString
vendorString
vendor_idString
requested_delivery_dateISODateTime
ship_not_before_dateISODateTime
ship_no_later_than_dateISODateTime
depositor_order_numberString
departmentString
department_numberString
divisionString
service_levelString
internal_supplier_numberString
terms_of_saleString
retailer_notesString
quote_numberString
sales_requirement_codeString
reference_fieldsJSONObjectScalar
wholesale_shipping_detailsWholesaleShippingDetailsInput

The shipping details to be used to create a new wholesale order

Referenced By

Example

{
  "customer_account_id": "abc123",
  "order_number": "abc123",
  "partner_order_id": "abc123",
  "shop_name": "abc123",
  "fulfillment_status": "abc123",
  "order_date": "abc123",
  "total_tax": "abc123",
  "subtotal": "abc123",
  "total_discounts": "abc123",
  "total_price": "abc123",
  "box_name": "abc123",
  "currency": "abc123",
  "ready_to_ship": true,
  "insurance_amount": "abc123",
  "shipping_lines": CreateShippingLinesInput,
  "shipping_address": CreateOrderAddressInput,
  "billing_address": CreateOrderAddressInput,
  "from_name": "abc123",
  "note_attributes": OrderNoteAttributeInput,
  "tags": "abc123",
  "line_items": CreateWholesaleLineItemInput,
  "gift_note": "abc123",
  "gift_invoice": true,
  "require_signature": true,
  "adult_signature_required": true,
  "alcohol": true,
  "insurance": true,
  "allow_partial": true,
  "allow_split": true,
  "custom_invoice_url": "abc123",
  "email": "abc123",
  "profile": "abc123",
  "packing_note": "abc123",
  "required_ship_date": "abc123",
  "auto_print_return_label": true,
  "hold_until_date": "abc123",
  "incoterms": "abc123",
  "tax_id": "abc123",
  "tax_type": "abc123",
  "flagged": true,
  "saturday_delivery": true,
  "ignore_address_validation_errors": true,
  "skip_address_validation": true,
  "priority_flag": true,
  "allocation_priority": 987,
  "holds": HoldsInput,
  "dry_ice_weight_in_lbs": "abc123",
  "ftr_exemption": "abc123",
  "address_is_business": true,
  "tote_qa": true,
  "do_not_print_invoice": true,
  "ignore_payment_capture_errors": true,
  "partner_source_name": "abc123",
  "shipping_option": "COURIER",
  "staging_location_id": 987,
  "picking_flow": "DESKTOP",
  "outbound_progress": "AWAITING_SCHEDULE",
  "pickup_date": "abc123",
  "preparation_date": "abc123",
  "order_type": "abc123",
  "gs1_labels_required": true,
  "trading_partner_id": "abc123",
  "trading_partner_name": "abc123",
  "store_location_number": "abc123",
  "store_address1": "abc123",
  "store_city": "abc123",
  "store_country": "abc123",
  "store_state": "abc123",
  "store_zip": "abc123",
  "distribution_center": "abc123",
  "distribution_center_number": "abc123",
  "purchase_order_type": "abc123",
  "vendor": "abc123",
  "vendor_id": "abc123",
  "requested_delivery_date": "abc123",
  "ship_not_before_date": "abc123",
  "ship_no_later_than_date": "abc123",
  "depositor_order_number": "abc123",
  "department": "abc123",
  "department_number": "abc123",
  "division": "abc123",
  "service_level": "abc123",
  "internal_supplier_number": "abc123",
  "terms_of_sale": "abc123",
  "retailer_notes": "abc123",
  "quote_number": "abc123",
  "sales_requirement_code": "abc123",
  "reference_fields": "abc123",
  "wholesale_shipping_details": WholesaleShippingDetailsInput
}