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

Storefront-assigned order ID; distinct from Shiphero order_id.

shop_nameString

Shop name for this order.

fulfillment_statusString

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

order_dateISODateTime

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

total_taxString

Monetary amount as a decimal value in the record currency; not cents.

subtotalStringDEPRECATED 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_discountsString

Monetary amount as a decimal value in the record currency; not cents.

total_priceStringDEPRECATED 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_nameString

Box name for this order.

currencyString

ISO 4217 currency code for the monetary values on this order.

ready_to_shipBooleanDEPRECATED 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_amountDecimal

Monetary amount as a decimal value in the record currency; not cents.

shipping_linesCreateShippingLinesInput

Shipping lines for this order.

shipping_addressCreateOrderAddressInput!

Shipping address details for this order.

billing_addressCreateOrderAddressInput

Billing address details for this order.

third_party_shipperThirdPartyShipperInput

Third-party billing details. If supplied, account_number, zip, and country are required.

from_nameString

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

List of line items associated with this order.

gift_noteString

Gift note for this order.

gift_invoiceBoolean

Whether this order should use a gift invoice.

require_signatureBoolean

Whether this order requires a delivery signature.

adult_signature_requiredBoolean

Whether this order requires an adult delivery signature.

alcoholBoolean

Whether this order contains alcohol and requires alcohol shipping handling.

insuranceBoolean

Whether shipping insurance is enabled for this order.

allow_partialBoolean

True when this order allows partial; false otherwise.

allow_splitBoolean

True when this order allows split; false otherwise.

custom_invoice_urlString

URL for the custom invoice URL resource.

emailString

Email address for the contact.

profileString

Profile for this order.

packing_noteString

Packing note for this order.

required_ship_dateISODateTime

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

auto_print_return_labelBoolean

Whether a return label should be printed automatically for this order.

hold_until_dateISODateTime

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

incotermsString

Incoterms for this order.

tax_idString

Public API tax ID that identifies the related record.

tax_typeString

Tax type for this order.

flaggedBoolean

Whether this order is flagged for attention.

saturday_deliveryBoolean

Whether Saturday delivery is requested for this order.

ignore_address_validation_errorsBoolean

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_validationBoolean

When true, address validation is skipped for this order.

priority_flagBoolean

Whether this order is marked as priority.

allocation_priorityInt

Allocation priority as a numeric value.

holdsHoldsInput

Holds for this order.

dry_ice_weight_in_lbsString

Dry ice weight in lb in pounds.

ftr_exemptionDecimal

Foreign Trade Regulations exemption value. Deprecated; use ftr_exemption_value.

address_is_businessBoolean

Whether the ship-to address is a business address.

tote_qaBoolean

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

do_not_print_invoiceBoolean

Whether invoices should be suppressed when printing documents for this order.

ignore_payment_capture_errorsBoolean

Whether to ignore payment capture errors for this order.

service_point_idString

Public API service point ID that identifies the related record.

partner_source_nameString

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

Referenced By

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"
}