input CreateOrderInput

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[CreateLineItemInput]
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.)

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": CreateLineItemInput,
  "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"
}