{ "opencollection": "1.0.0", "info": { "name": "Shipments Address Orders API", "version": "3.0.0" }, "items": [ { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of orders", "type": "http" }, "http": { "method": "GET", "url": "https://panel.sendcloud.sc/api/v3/orders", "params": [ { "name": "integration", "value": "", "type": "query", "description": "Filter orders by one or more integration IDs. Use a comma separated list, e.g. `integration=41,68,419`.\n\nYou can get your integration IDs from the [Retrieve a list of integrations](/api/v3/integrations/retrieve-a-list-of-integrations) endpoint." }, { "name": "order_number", "value": "", "type": "query", "description": "Filter orders by a specific order number, e.g. `order_number=ORDER_284565`. The filtering is case insensitive." }, { "name": "order_id", "value": "", "type": "query", "description": "Filter orders by a specific order id, e.g. `order_id=1896e94b-c01b-4e73-a9e7-57f51c8a4c77`. The filtering is case insensitive." }, { "name": "status", "value": "", "type": "query", "description": "Filter orders based on their status, e.g. `status=unshipped`. The filtering is case insensitive." }, { "name": "order_created_at", "value": "", "type": "query", "description": "Find orders that were created on a specific date, e.g. `order_created_at=2023-04-28`." }, { "name": "order_created_at_min", "value": "", "type": "query", "description": "Find orders that were created at or after a specific date, e.g. `order_created_at_min=2023-04-28`." }, { "name": "order_created_at_max", "value": "", "type": "query", "description": "Find orders that were created at or before a specific date, e.g. `order_created_at_max=2023-04-28`." }, { "name": "order_updated_at", "value": "", "type": "query", "description": "Find orders that were updated on a specific date, e.g. `order_updated_at=2023-04-28`." }, { "name": "order_updated_at_min", "value": "", "type": "query", "description": "Find orders that were updated at or after a specific date, e.g. `order_updated_at_min=2023-04-28`." }, { "name": "order_updated_at_max", "value": "", "type": "query", "description": "Find orders that were updated at or before a specific date, e.g. `order_updated_at_max=2023-04-28`." }, { "name": "sort", "value": "", "type": "query", "description": "Sort the orders in the response by using one or more of the following values:\n - `integration`: Sort by the integration ID of the retrieved orders; to sort in descending order, use `-integration`\n - `order_number`: Sort by the order number of the retrieved orders; to sort in descending order, use `-order_number`.\n - `order_created_at`: Sort by the date of an order creation of the retrieved orders; to sort in descending order, use `-order_created_at`\n - `order_updated_at`: Sort by the date of an order update of the retrieved orders; to sort in descending order, use `-order_updated_at`\n - `pk`: Sort by the ID (autogenerated internal ID) of the retrieved orders; to sort in descending order, use `-pk`\n\nAdditional information about this query:\n - Any valid combination of the above values is supported, e.g. `sort=integration,-order_created_at`. \n - In case of conflicting `sort` values, e.g. `/?sort=integration,-integration`, the conflicting value will be ignored.\n - If the `sort` query parameter is not set, the sorting of the retrieved orders will default to `-pk`.\n - If an unsupported `sort` value is provided, the results will be sorted by the default (`-pk`)." }, { "name": "page_size", "value": "", "type": "query", "description": "The maximum number of results to be returned per page" }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor query string is used as the pivot value to filter results. If no value is provided, the first page of results will be returned. To get this value, you must encode the offset, reverse and position into a base64 string.\n\nThere are 3 possible parameters to encode:\n - `o`: Offset\n - `r`: Reverse\n - `p`: Position\n \nFor example, `r=1&p=300` encoded as a base64 string would be `cj0xJnA9MzAw`. The query string would then be `cursor=cj0xJnA9MzAw`." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a list of orders filtered by integration, order number, order ID, order status, creation date, and update date. You can also optionally sort the results and pass a `cursor` value." }, { "info": { "name": "Create/Update orders in batch", "type": "http" }, "http": { "method": "POST", "url": "https://panel.sendcloud.sc/api/v3/orders", "headers": [ { "name": "Sendcloud-Partner-Id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this endpoint to insert orders into a Sendcloud API integration." }, { "info": { "name": "Retrieve an order", "type": "http" }, "http": { "method": "GET", "url": "https://panel.sendcloud.sc/api/v3/orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Filtering on the Sendcloud order ID" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Find a specific order by its order ID." }, { "info": { "name": "Update an order", "type": "http" }, "http": { "method": "PATCH", "url": "https://panel.sendcloud.sc/api/v3/orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Filtering on the Sendcloud order ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Partially update some fields of an order." }, { "info": { "name": "Delete an order", "type": "http" }, "http": { "method": "DELETE", "url": "https://panel.sendcloud.sc/api/v3/orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Filtering on the Sendcloud order ID" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete an order by its unique id." } ] } ], "bundled": true }