Overview

An order represents a customer's request to purchase one or more products in VU Custom. The Orders API provides comprehensive endpoints for creating, retrieving, updating, and managing order information, including associated order lines, fulfillments, and tags.

Core Concepts

Order Structure

• Basic order information (order number, dates, currency)

• B2B organization details

• Shipping and billing information (sold-to and ship-to details)

• Order lines containing product and customization details

• Fulfillment information

• Custom attributes and tags

Available Methods

Order Management

1. Create an Order

   • POST /api/{version}/orders

   • Creates a new order with product details and customer information

2. Retrieve Orders

   • GET /api/{version}/orders

   • List orders with optional filters:

     • Status

     • Tags (with/without)

     • Limit

     • Since ID

   • GET /api/{version}/orders?id={id}

   • Retrieve a specific order by ID or order number

3. Update an Order

   • PUT /api/{version}/orders

   • Update order details such as:

     • Purchase order number

     • Sales order number

     • Shipping method

     • Notes

     • Custom attributes

4. Delete an Order

   • DELETE /api/{version}/orders

   • Remove an order by ID or order number

Tag Management

1. Add Tags

   • POST /api/{version}/orders/tags

   • Add tags to a specific order

   • POST /api/{version}/orders/tags/bulk

   • Add tags to multiple orders

2. Delete Tags

   • DELETE /api/{version}/orders/tags

   • Remove tags from a specific order

   • DELETE /api/{version}/orders/tags/bulk

   • Remove tags from multiple orders

Key Features

• Support for B2B and B2C orders

• Comprehensive order tracking

• Flexible customization through custom attributes

• Detailed fulfillment tracking

• Tag-based organization and filtering

• Bulk operations for efficient management