For the complete documentation index, see llms.txt. This page is also available as Markdown.

Requirements for Order Import

VU's OMS has the ability to autonomously pull orders from integrated platforms, and also the ability for platforms to push orders to the OMS via the Order API. In both scenarios, there are required fields that must be populated on the Order for a successful import.

Required Fields

Core Order Details:

  • created_at

  • name (the order number, like "#1001")

  • shipping_lines (must be present)

Line Items: The order must include a line_items array where each item has:

  • id

  • sku

  • price

  • title

  • quantity

  • vendor

*Address Information: The order must contain either a shipping_address object or a customer.default_address object with the following fields:

  • first_name

  • last_name

  • address1

  • city

  • zip

  • country_code

*Address can be configured to be optional at a company level, however it remains required by default. Please reach out to a support representitive to assist with this cofiguration if desired.

Customization Token: At least one line item must have a properties array containing an object with a name of recipe_id or recipeid and a corresponding value (the recipe token).

Optional Fields

While not required for a successful import, the service will process and save the following fields if they are present in the Order data:

Order Level:

  • note

  • total_weight

Address Level:

  • address2

  • company

  • phone

  • province_code (for state/region)

The entire billing_address object and its fields.

Line Item Level:

  • grams

  • product_id

  • variant_id

Additional Requirements

  • Products must be active for the linking/import to work.

  • Products must have inventory, upcharge items as well.

  • If a Company has multiple stores connected, order numbers across all stores must be unique. For example if two stores both have Order# 1001, the import of that order from the second store would fail as the system would already see that Order# present. Uniqueness can be achieve by configuring a pre-fix ahead of the Order# assignment within the store.

Last updated