{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/","routeSlug":"/"},{"type":"link","label":"Orderwerks REST API","link":"/openapi","routeSlug":"/openapi"},{"type":"link","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication"},{"type":"link","label":"Conventions","link":"/openapi/section/conventions","routeSlug":"/openapi/section/conventions"},{"type":"link","label":"Terminology","link":"/openapi/section/terminology","routeSlug":"/openapi/section/terminology"},{"type":"separator","label":"Customers"},{"type":"group","label":"Vendors","link":"/openapi/vendors","routeSlug":"/openapi/vendors","items":[{"label":"List customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/vendors/listvendors","routeSlug":"/openapi/vendors/listvendors","metadata":{"seo":{"title":"List customers","description":"Returns the supplier's customers (vendors) as a paged list of supplier-to-customer connections; the customerrecord is under Vendor on each row. Requires supplier-level access."}},"httpPath":"/vendors"},{"label":"Create a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/vendors/createvendor","routeSlug":"/openapi/vendors/createvendor","metadata":{"seo":{"title":"Create a customer","description":"Creates a customer (vendor) with optional billing address, shipping address, primary contact and account note,without an order. Idempotent on supplier + newVendor.email: a retry after a lost response returns the existingcustomer's references instead of creating a duplicate."}},"httpPath":"/vendors"},{"label":"Get a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/vendors/getvendor","routeSlug":"/openapi/vendors/getvendor","metadata":{"seo":{"title":"Get a customer","description":"Returns one customer (vendor) with its addresses, integration links and shipping preferences."}},"httpPath":"/v1/vendors/{vendorGuid}"},{"label":"Update a customer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/vendors/updatevendor","routeSlug":"/openapi/vendors/updatevendor","metadata":{"seo":{"title":"Update a customer","description":"Updates a customer's name, email, addresses and settings. name and email are required; everything else isoptional and left unchanged when omitted."}},"httpPath":"/v1/vendors/{vendorGuid}"}]},{"type":"separator","label":"Catalog"},{"type":"group","label":"Catalogs","link":"/openapi/catalogs","routeSlug":"/openapi/catalogs","items":[{"label":"List catalogs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/catalogs/listcatalogs","routeSlug":"/openapi/catalogs/listcatalogs","metadata":{"seo":{"title":"List catalogs","description":"Returns the catalogs visible to the caller. Supplier users see every catalog; a customer context (vendorGuid)narrows the list to the catalogs that customer may order from."}},"httpPath":"/v1/catalogs"}]},{"type":"group","label":"Catalog Items","link":"/openapi/catalog-items","routeSlug":"/openapi/catalog-items","items":[{"label":"List catalog items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/catalog-items/listcatalogitems","routeSlug":"/openapi/catalog-items/listcatalogitems","metadata":{"seo":{"title":"List catalog items","description":"Paged list of the items in a catalog. With API key authentication each item carries the fixed field set shownin the schema; with user session headers the full item model is returned."}},"httpPath":"/v1/catalog/{catalogGuid}/catalog_items"},{"label":"Get a catalog item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/catalog-items/getcatalogitem","routeSlug":"/openapi/catalog-items/getcatalogitem","metadata":{"seo":{"title":"Get a catalog item","description":"Returns one catalog item with its category, attachments, options and attributes."}},"httpPath":"/v1/catalog/{catalogGuid}/catalog_items/{catalogItemGuid}"},{"label":"Get catalog items by ids or GUIDs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/catalog-items/getcatalogitemsbybatch","routeSlug":"/openapi/catalog-items/getcatalogitemsbybatch","metadata":{"seo":{"title":"Get catalog items by ids or GUIDs","description":"Returns the requested items in one call. Unknown ids are skipped, not reported."}},"httpPath":"/v1/catalog/{catalogGuid}/catalog_items/batch"},{"label":"Search catalog items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/catalog-items/searchcatalogitems","routeSlug":"/openapi/catalog-items/searchcatalogitems","metadata":{"seo":{"title":"Search catalog items","description":"Full-text search over a catalog (name, SKU, description, UPC) with optional category, price-group and attributefilters. This is the endpoint the order-entry screens use."}},"httpPath":"/v1/catalog/{catalogGuid}/catalog_items/typeahead"},{"label":"Look up catalog items by SKU","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/catalog-items/lookupcatalogitembysku","routeSlug":"/openapi/catalog-items/lookupcatalogitembysku","metadata":{"seo":{"title":"Look up catalog items by SKU","description":"Fast exact-SKU lookup within a catalog. Returns a lightweight projection; use Get a catalog item for the full record."}},"httpPath":"/v1/catalog_items/sku-lookup"},{"label":"List catalog items (legacy path)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/catalog-items/listcatalogitemslegacy","routeSlug":"/openapi/catalog-items/listcatalogitemslegacy","metadata":{"seo":{"title":"List catalog items (legacy path)","description":"Legacy alias of GET /v1/catalog/{catalogGuid}/catalog_items. Same parameters and response; use the new path."}},"httpPath":"/v1/{catalogGuid}/catalogItems"}]},{"type":"group","label":"Price Groups","link":"/openapi/price-groups","routeSlug":"/openapi/price-groups","items":[{"label":"List price groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/price-groups/listpricegroups","routeSlug":"/openapi/price-groups/listpricegroups","metadata":{"seo":{"title":"List price groups","description":"Returns the price groups defined on a catalog. name is the key used in each catalog item's pricing object."}},"httpPath":"/v1/catalog/{catalogGuid}/price_groups"}]},{"type":"separator","label":"Orders"},{"type":"group","label":"Orders","link":"/openapi/orders","routeSlug":"/openapi/orders","items":[{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/listordersapi","routeSlug":"/openapi/orders/listordersapi","metadata":{"seo":{"title":"List orders","description":"Paged list of the supplier's orders, newest first, with a reduced projection of each order and its lines(Order_Items carry id, item_no, qty, note and the item's id, name, sku)."}},"httpPath":"/v1/orders"},{"label":"List orders (filtered)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/listorders","routeSlug":"/openapi/orders/listorders","metadata":{"seo":{"title":"List orders (filtered)","description":"Paged, filterable order list used by the Orderwerks web app. Supplier users see all of the supplier's orders;customer users see their own."}},"httpPath":"/v1/orders/list"},{"label":"Get an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/getorder","routeSlug":"/openapi/orders/getorder","metadata":{"seo":{"title":"Get an order","description":"Returns the full order with its lines, addresses, customer, state history and related records, plus any related orders (backorders, parent order)."}},"httpPath":"/v1/orders/{orderGuid}"},{"label":"Update an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/updateorder","routeSlug":"/openapi/orders/updateorder","metadata":{"seo":{"title":"Update an order","description":"Partial update of an order's header fields. Rejected with 403 when the order's current workflow step isread-only for the caller's user type."}},"httpPath":"/v1/orders/{orderGuid}"},{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/createorderv2","routeSlug":"/openapi/orders/createorderv2","metadata":{"seo":{"title":"Create an order","description":"Creates an order with its lines for an existing customer and, unless remainInPreliminary is true, submits itinto the supplier's workflow. This is the recommended endpoint for integrations."}},"httpPath":"/v2/order"},{"label":"Create an order (with optional new customer)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/createorderwithitems","routeSlug":"/openapi/orders/createorderwithitems","metadata":{"seo":{"title":"Create an order (with optional new customer)","description":"Creates an order with its lines, optionally creating the customer in the same call (newVendor* fields).Used by the Orderwerks mobile sales app; also available to integrators with an API key."}},"httpPath":"/v1/orderWithItems"},{"label":"Create an empty order (legacy)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/createorderv1","routeSlug":"/openapi/orders/createorderv1","metadata":{"seo":{"title":"Create an empty order (legacy)","description":"Creates an order header for the customer given in the vendorGuid header, without lines. Lines are addedafterwards through the order-entry screens. Prefer POST /v2/order or POST /v1/orderWithItems."}},"httpPath":"/v1/order"},{"label":"Submit an order / advance its state","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/submitorder","routeSlug":"/openapi/orders/submitorder","metadata":{"seo":{"title":"Submit an order / advance its state","description":"Moves an order to the next step of its workflow (or to order_state_id when given), reserving inventory andsending the step's notifications. Orders created through POST /v2/order are submitted automatically; use thisfor orders created with remainInPreliminary: true or by POST /v1/order."}},"httpPath":"/v1/order/submit"}]}]}