{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Orders API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Get all Orders", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/orders", "headers": [ { "name": "x-moltin-customer-token", "value": "" } ], "params": [ { "name": "include", "value": "", "type": "query", "description": "Comma-delimited string of entities to include (items, tax_items, custom_discounts, promotions)." }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of records per page." }, { "name": "page[offset]", "value": "", "type": "query", "description": "The number of records to offset the results by." }, { "name": "filter", "value": "", "type": "query", "description": "Filter expression for searching orders. See filtering documentation for available operators and attributes." } ] }, "docs": "This endpoint returns all orders with custom flow fields. The pagination offset is set to fetch a maximum of 10,000 orders. If the store has 10,000 orders, and you fetch the orders without using filters, an error is returned. Use a filter to view orders when the order is beyond the 10,000 mark.\n\n:::note\n\n- Pass the `X-Moltin-Customer-Token` header to limit orders to a specific customer. See [Customer Tokens](/docs/customer-management/customer-management-api/customer-tokens).\n- Pass the `EP-Accou" }, { "info": { "name": "Get an Order", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/orders/:orderID", "params": [ { "name": "orderID", "value": "", "type": "path", "description": "The ID of the order." }, { "name": "include", "value": "", "type": "query", "description": "Comma-delimited string of entities to include (items, tax_items, custom_discounts, promotions)." } ] }, "docs": "Use this endpoint to retrieve a specific order.\n\n### Includes\n\nYou can include related resources with the order response by using the `include` query parameter.\n\n| Name | Required | Type | Description |\n|:----------|:---------|:---------|:------------|\n| `include` | Optional | `string` | Comma-delimited string of entities that can be included. The included options are `items`, `tax_items`, `custom_discounts`, or `promotions`. |" }, { "info": { "name": "Update an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/v2/orders/:orderID", "params": [ { "name": "orderID", "value": "", "type": "path", "description": "The unique identifier of the order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can only update custom data, `shipping`, `shipping_address`, and status of orders. All other settings in the order object are immutable.\n\n This endpoint allows you to:\n\n- **Update an order number and external reference**: You can update an existing order that does not have an `order_number` and `external_ref`, modify the `order_number` and `external_ref` values, or remove them by passing an empty value in the `order_number` and `external_ref` fields.\n- **Cancel an order**: You can cancel an " }, { "info": { "name": "Get Order Items", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/orders/:orderID/items", "params": [ { "name": "orderID", "value": "", "type": "path", "description": "The ID of the order." }, { "name": "include", "value": "", "type": "query", "description": "Comma-delimited string of entities to include (tax_items, custom_discounts, promotions)." } ] }, "docs": "Use this endpoint to retrieve order items.\n\n### Includes\n\nYou can include related resources with the order items response by using the `include` query parameter.\n\n| Name | Required | Type | Description |\n|:----------|:---------|:---------|:------------|\n| `include` | Optional | `string` | Comma-delimited string of entities that can be included. The included options are `tax_items`, `custom_discounts`, or `promotions`. |" }, { "info": { "name": "Anonymize Orders", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/orders/anonymize", "body": { "type": "json", "data": "{}" } }, "docs": "You can anonymize an order when it is fulfilled, canceled, or fully refunded.\n\nWhen anonymization is successful, Personal Identifiable Information such as customer details, `shipping_address`, and `billing_address` are replaced with *.\n" }, { "info": { "name": "Confirm Order", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/orders/:orderID/confirm", "params": [ { "name": "orderID", "value": "", "type": "path", "description": "The unique identifier of the order to confirm." } ] }, "docs": "Use this endpoint to confirm an order. Confirming an order finalizes it and makes it ready for processing.\n" } ] } ], "bundled": true }