Channable orders API

The orders API from Channable — 10 operation(s) for orders.

OpenAPI Specification

channable-orders-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Channable order connection order_attachments orders API
  description: "# Introduction\n\nWelcome to the Channable API __v1__.\n\nThis version of the Channable API allows you to:\n\n- Access orders\n- Manage order shipments\n- Update the stock of an offer on all marketplaces\n- Access returns\n\n### Details\n\n|    Key             |       Value\n-------------     | -----------\nApi version       | `v1`, `v2`\nProtocol          | `HTTPS`\nHostname          | `api.channable.com`\nCommon Path v1    | `/v1/companies/:company_id/projects/:project_id`\nCommon Path v2    | `/v2/companies/:company_id/projects/:project_id`\n\n\nThe <em>Common Path</em> is shared by all endpoints except the transporters endpoints in this version of our API. Note that you have to replace <code>:company_id</code> and <code>:project_id</code> with valid values. All endpoints using v2 will state so in their names, and should use the <em>common path v2</em>. All other endpoints are v1 endpoints and should use <em>Common Path v1</em>.\n\n## Taxonomy\n\n\n|    Term         | Description\n-------------     | -----------\n`Platform`        | A webshop platform, such as WooComerce, Lightspeed, etc.\n`Marketplace`     | A place where you can sell your products, such as Amazon, Bol, eBay, etc. Sometimes referred to as _channel_.\n`Order`           | A purchase of any products made by a client.\n`Offer`           | A selling proposal made by a seller over any class of products. It includes price, stock and other seller-dependent values.\n\n\n## Rate Limiting\n\nThe Channable API has a rate limiting policy to which you must comply.<br>\nIt is defined on a per-company basis, meaning that generating new API tokens will not circumvent our rate-limiting.\n\n|    Frequency             | Burst\n-------------              | -----------\nMax 4 requests per second  | Burst of 200 requests\n\n**Note**: We use the [Leaky Bucket algorithm](https://en.wikipedia.org/wiki/Leaky_bucket) for rate-limiting.\n\n## Getting started\n\n\nTo get started you need to:\n\n1. Find the project ids you are interested in\n1. Find your Channable company id\n1. Generate an **API token** for your company\n\n**Note**: Information about the supported channels can be found in our [help center](https://helpcenter.channable.com/hc/en-us/articles/360011094300-For-which-marketplaces-does-Channable-support-an-order-connection-integration-).\n\n### 1. Find your project ids\n\nTo find the project ids you are interested in:\n\n1. Log in to the <a target=\"\\\\_blank\" href=\"https://app.channable.com\">Channable app</a>\n2. Select a project\n3. Open the project `Settings`\n4. Copy the _Project id_ value\n\n\n### 2. Generate an API Token for your company\n\nTo both find your Channable `company_id` and to generate a new **API token** for your company, go to [app.channable.com](https://app.channable.com) and sign in.\n\nOn the main page navigate to company settings then channabke API.\nFrom here you can see your company id, as well as generate your API token.\n\n<img src='https://lh3.googleusercontent.com/d/1yUAdfXLRryVV9i0ce0mJpOX3c7z97HSD=w1000' />\n\n**Notes**:\n\n- Only owners of companies are able to generate an API Token.\n- Channable does not store your tokens. Please store them securely.\n- In case you lose or leak your token, generate a new one. The previously generated tokens can be revoked by you or will expire after 1 year.\n- Two API tokens can be valid at any time, allowing you to seamlessly change to a new token, if needed.\n\n### 3. Using the API Token\n\nYou must include your API token in every request you make to Channable.<br/>\nThe token should be included in the headers of the request: `Authorization: Bearer your_api_token`\n\n<aside class=\"notice\">\nYou must replace <code>your_api_token</code> with your API token.\n</aside>\n\nAfter generating your API token you are ready to try out the endpoints and build your integration\nusing the Channable Sandbox.\n\n**How to include the token in your requests:**\n\n```shell\n# Headers method: Authorization: Bearer\ncurl \"api_endpoint_here\"\n  -H \"Authorization: Bearer your_api_token\"\n```\n\n\n### Common error codes and their meanings\n\nThe Channable API uses the following error codes:\n\nCode | Meaning | Reason\n---------- | ------- | -------\n400 | Bad Request | The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)\n401 | Unauthorized | You are using an invalid or already revoked API token.\n403 | Forbidden | You are not allowed to access the resources your request targets.\n404 | Not Found | The targeted resources could not be found.\n405 | Method Not Allowed | You tried to access an endpoint with an invalid HTTP method.\n406 | Not Acceptable | You requested a format that isn't json.\n409 | Conflict | Your request could not be completed due to a conflict with the current state of the target resource.\n422 | Unprocessable Entity | We could understand the content type of the request entity, but we are unable to process the contained instructions.\n429 | Too Many Requests | You have sent too many requests in a given amount of time, thus exceeding our rate-limiting policy. Please try again later.\n500 | Internal Server Error | We had a problem with our server. Please try again later.\n503 | Service Unavailable | We are temporarily offline for maintenance. Please try again later.\n\n\n## Sandbox Testing\n\nThe Channable API sandbox lets you test your order integration with the Channable API in a safe\nenvironment without sending requests to the marketplaces you want to connect to. All data is mocked\nbut the structure of the data and API calls needed to manage your orders are the same no matter\nwhich marketplace you end up connecting with.\n\n\n### Setup\n\nTo set up a test environment with the Channable Sandbox you must first make a connection with the\nSandbox. This can be done in the same way as all other connections within Channable by going to\n\"Company settings\" -> \"Connections\" and clicking on \"+ Add new connection\".\n\n<img src='https://lh3.googleusercontent.com/d/1iBA33tS5JmjdJEVDuS0ks5j9MJEewJMg=w1000' />\n\nSelect \"Channable Sandbox\", give the connection a label and click on the blue \"Create\" button.\nNo further information is needed.\n\nOnce you have made a connection, navigate to the project you want to use and click on\n\"Setup\" -> \"Setup orders\" > \"+ Setup orders\".\n\n<img src='https://lh3.googleusercontent.com/d/1zjpfcCbbU84GD45qMn3wrI3WFMNk438D=w1000' />\n\nFrom here make an order connection between the \"Channable API\" and the \"Channable Sandbox\" and\nactivate the order connection. You are now ready to start testing.\n\n<img src='https://lh3.googleusercontent.com/d/1piCcRzylFAy9uZf6vpjdukozC9-mgV_q=w1000' />\n\n### Orders\n\nTo create a test order, navigate to \"Setup\" -> \"Orders\" -> \"Settings\" of the Channable Sandbox\norder connection.\n\n<img src='https://lh3.googleusercontent.com/d/11wBOEB55t6_Y934xM3N50JtOmSbJfxGW=w1000' />\n\nFrom here click on the gear in the top right and \"Send test order\".\n\n<img src='https://lh3.googleusercontent.com/d/1f1tn9uooKz1uy0uq9xvfcMpREn5zKDVW=w1000' />\n\nIn the popup fill in an item id and click the blue \"Send test order\" button. A test order has now\nbeen created, and you can use all request methods described in \"Orders\" to interact with it. If you\nneed special test cases, most data in the test order can be provided by you in the popup when you\nclick on \"Send test order\".\n\n\n### Shipments/Cancellations\n\nOnce one or more testorders have been created, use the request methods described in \"Shipment\nupdate\" and \"Cancellation update\" under \"Orders\" above to mark an order as \"shipped\" and to give it\ntrack & trace information or to mark the order as \"cancelled\".\n\n\n### Offers\n\nTo test sending offer updates, that is updating the stock value on all marketplaces that you have\nan order connection to, you can use the request methods described in \"Offers\" above. You do not need\nto have created a test order to test this as you can update the stock value of any product in your\nstore, also products that you have not received an order for through Channable.\n\n\n### Returns\n\nReturns come from the marketplaces you will connect to. In order to test this, navigate to\n\"Setup\" -> \"Setup orders\" -> \"Settings\" of the Channable Sandbox order connection. \n\n<img src='https://lh3.googleusercontent.com/d/11wBOEB55t6_Y934xM3N50JtOmSbJfxGW=w1000' />\n\nFrom here click on the gear in the top right and \"Send test return\".\n\n<img src='https://lh3.googleusercontent.com/d/1Xdbdn329jneJqwiqxMPXV4d_nFrAyb1H=w1000' />\n\nIn the popup fill in a Channable order id and click the blue \"Send test return\" button. A test\nreturn has now been created for the order id you filled in. You can now use all request methods\ndescribed in \"Returns\" to handle the return.\n\n\n### When you are done testing\n\nOnce you are satisfied with your Channable API setup and want to go live, contact our\n<a target=\"\\\\_blank\" href=\"https://www.channable.com/company/contact/\">support department</a>\nand they will help you setup the order connections.\n"
  version: v1
  x-logo:
    url: https://www.channable.com/_next/image?url=https%3A%2F%2Fmedia.graphassets.com%2FcntRnbAcSrCmS1wLTWrb&w=256&q=75
tags:
- name: orders
paths:
  /v1/companies/{company_id}/projects/{project_id}/orders:
    get:
      tags:
      - orders
      summary: All Orders
      description: "<h3 style=\"background-color:#EC771A;color:#FFFFFF;margin:5px\">This operation is deprecated.\nUse <a href=\"https://api.channable.com/v1/docs#tag/orders/operation/all_orders_v2_v2_companies__company_id__projects__project_id__orders_get\">All orders v2</a> instead.</h3>\n\nThis endpoint retrieves all orders for a given project of your company, sorted from most recent\nto oldest. Optionally, you can pass query parameters to customize the response content.\n\nNote that the order data itself (like address information) can not be modified.\n\n**Timezones**\n\nWhen using the `start_date`, `end_date`, `last_modified_after`, `last_modified_before`,\n`retrieved_at_start` or `retrieved_at_end` parameters please keep in mind that the we will\ninterpret the provided dates and times to be in UTC timezone.\n\nThe timestamps on the returned orders are ISO 8601 compliant and have a UTC offset of +00:00.\n\n**Example usage**\n\nSuppose the following scenario for a given project of yours:\n    - The project contains the orders `o1`, `o2`, `o3`, and `o4` (from oldest to most recent)\n    - `o3` contains some error\n    - `o1` and `o4` are searchable by the term `t`\n    - `o3` is searchable by the term `tE`\n\n|  Request parameters                          | Response\n| -------------                                | -----------\n| _none_                                       | `{\"orders\": [o4, o3, o2, o1], \"error_count\": 1, \"total\": 4}`\n| `?errors=true`                               | `{\"orders\": [o3], \"error_count\": 1, \"total\": 1}`\n| `?limit=2`                                   | `{\"orders\": [o4, o3], \"error_count\": 1, \"total\": 2}`\n| `?offset=1`                                  | `{\"orders\": [o3, o2, o1], \"error_count\": 1, \"total\": 3}`\n| `?offset=4`                                  | `{\"orders\": [], \"error_count\": 1, \"total\": 0}`\n| `?offset=1&limit=1`                          | `{\"orders\": [o3], \"error_count\": 1, \"total\": 1}`\n| `?offset=1&limit=2`                          | `{\"orders\": [o3, o2], \"error_count\": 1, \"total\": 2}`\n| `?offset=1&limit=2&errors=true`              | `{\"orders\": [o3], \"error_count\": 1, \"total\": 1}`\n| `?search=t`                                  | `{\"orders\": [o4, o1], \"error_count\": 0, \"total\": 2}`\n| `?search=t&errors=true`                      | `{\"orders\": [], \"error_count\": 1, \"total\": 0}`\n| `?search=tE`                                 | `{\"orders\": [o3], \"error_count\": 1, \"total\": 1}`\n| `?search=tE&errors=true`                     | `{\"orders\": [o3], \"error_count\": 1, \"total\": 1}`\n| `?offset=1&limit=2&search=t&errors=true`     | `{\"orders\": [], \"error_count\": 1, \"total\": 0}`\n| `?status=not_shipped`                        | `{\"orders\": [o4], \"error_count\": 1, \"total\": 1}`\n| `?start_date=2018-01-01`                     | `{\"orders\": [o4, o3, o2], \"error_count\": 1, \"total\": 3}`\n| `?start_date=2018-01-01&end_date=2018-02-28` | `{\"orders\": [o3, o2], \"error_count\": 1, \"total\": 2}`\n| `?last_modified_after=2018-02-29`            | `{\"orders\": [o4], \"error_count\": 1, \"total\": 1}`"
      operationId: all_orders_companies__company_id__projects__project_id__orders_get
      deprecated: true
      parameters:
      - name: company_id
        in: path
        required: true
        schema:
          type: integer
          title: Company Id
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: download
        in: query
        required: false
        schema:
          type: boolean
          description: If true, a file download will be served
          default: false
          title: Download
        description: If true, a file download will be served
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/OrderStatus'
          - type: array
            items:
              $ref: '#/components/schemas/OrderStatus'
          - type: 'null'
          title: Status
      - name: channel
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Channel
      - name: errors
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Errors
      - name: search
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 1
          - type: 'null'
          description: Any text based search query
          title: Search
        description: Any text based search query
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: 'null'
          title: Start Date
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: 'null'
          title: End Date
      - name: retrieved_at_start
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: 'null'
          title: Retrieved At Start
      - name: retrieved_at_end
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: 'null'
          title: Retrieved At End
      - name: last_modified_after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: 'null'
          title: Last Modified After
      - name: last_modified_before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: 'null'
          title: Last Modified Before
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Max number of results in a single page.
          default: 100
          title: Limit
        description: Max number of results in a single page.
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Filter results starting from this offset.
          default: 0
          title: Offset
        description: Filter results starting from this offset.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecentOrders'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/companies/{company_id}/projects/{project_id}/anonymous_orders:
    get:
      tags:
      - orders
      summary: Anonymized All Orders
      description: 'This endpoint is identical to `/orders`, but the returned order data has all personal

        identifiable information (PII) removed.


        See the docs of `/orders` for more info on how to query this endpoint.'
      operationId: anonymized_all_orders_companies__company_id__projects__project_id__anonymous_orders_get
      parameters:
      - name: company_id
        in: path
        required: true
        schema:
          type: integer
          title: Company Id
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: search
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 1
          - type: 'null'
          description: Any text based search query
          title: Search
        description: Any text based search query
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: 'null'
          title: Start Date
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: 'null'
          title: End Date
      - name: last_modified_after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: 'null'
          title: Last Modified After
      - name: last_modified_before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: 'null'
          title: Last Modified Before
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Max number of results in a single page.
          default: 100
          title: Limit
        description: Max number of results in a single page.
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Filter results starting from this offset.
          default: 0
          title: Offset
        description: Filter results starting from this offset.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnonymizedRecentOrders'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/companies/{company_id}/projects/{project_id}/orders/{order_id}:
    get:
      tags:
      - orders
      summary: Single Order
      description: '<h3 style="background-color:#EC771A;color:#FFFFFF;margin:5px">This operation is deprecated.

        Use <a href="https://api.channable.com/v1/docs#tag/orders/operation/single_order_v2_v2_companies__company_id__projects__project_id__orders__order_id__get">Single order v2</a> instead.</h3>


        This endpoint retrieves an order, and its events, based on the order_id.


        **Understanding the address fields**


        There are two ways of storing the address information for order billing and shipping:


        Using the fields street, house_number, house_number_ext, and address_supplement

        Using the fields address1 and address2


        The first is more used in the Netherlands, where an address requires a house number, while the

        second version is more used abroad. We support both cases, and, in the example to the right,

        you see how to translate one into the other.


        **Understanding the price fields**


        An order contains a list of products purchased by a customer.

        The product.quantity stores the quantity of products of a given kind were purchased.

        The product.price is per product, not product.quantity * price_per_unit.

        The order.price.total is the sum of all purchased products'' price, shipping costs, and other

        applicable fees.'
      operationId: single_order_companies__company_id__projects__project_id__orders__order_id__get
      deprecated: true
      parameters:
      - name: company_id
        in: path
        required: true
        schema:
          type: integer
          title: Company Id
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: order_id
        in: path
        required: true
        schema:
          type: integer
          title: Order Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderWithEvents'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannableErrorResponse'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/companies/{company_id}/projects/{project_id}/orders/{order_id}/return:
    post:
      tags:
      - orders
      summary: Manual Return
      description: 'Manually create a return for the ordered products on the marketplace. NB! Only a limited number of marketplaces support this operation: Fruugo, Otto, Veepee, Zalando'
      operationId: manual_return_companies__company_id__projects__project_id__orders__order_id__return_post
      parameters:
      - name: order_id
        in: path
        required: true
        schema:
          type: integer
          title: Order Id
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: company_id
        in: path
        required: true
        schema:
          type: integer
          title: Company Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderReturnBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/companies/{company_id}/projects/{project_id}/orders/test/{order_config_id}:
    post:
      tags:
      - orders
      summary: Create Test Order
      description: 'This endpoint allows you to create one or more test orders containing fake data within Channable


        Warning: This endpoint is not meant to be part of an automated process, and could change without

        prior notice'
      operationId: create_test_order_companies__company_id__projects__project_id__orders_test__order_config_id__post
      parameters:
      - name: company_id
        in: path
        required: true
        schema:
          type: integer
          title: Company Id
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: order_config_id
        in: path
        required: true
        schema:
          type: integer
          title: Order Config Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestOrderBody'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Create Test Order Companies  Company Id  Projects  Project Id  Orders Test  Order Config Id  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/companies/{company_id}/projects/{project_id}/orders/{order_id}/shipment:
    post:
      tags:
      - orders
      summary: Shipment
      description: 'This endpoint allows you to update an order shipment status.

        We will then propagate the update to the involved marketplace.'
      operationId: shipment_companies__company_id__projects__project_id__orders__order_id__shipment_post
      parameters:
      - name: company_id
        in: path
        required: true
        schema:
          type: integer
          title: Company Id
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: order_id
        in: path
        required: true
        schema:
          type: integer
          title: Order Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannableShippingPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingResponseModel'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannableErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannableErrorResponse'
          description: Not Found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannableErrorResponse'
          description: Conflict
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/companies/{company_id}/projects/{project_id}/orders/{order_id}/cancel:
    post:
      tags:
      - orders
      summary: Cancellation
      description: 'This endpoint allows you to update an order status and set it to `cancelled`.

        We will then propagate the update to the involved marketplaces.


        Note that this only covers the case where the seller wants to cancel an order. If the buyer

        cancels an order, the marketplace requires the seller to manually confirm this cancellation in

        the marketplace seller account.'
      operationId: cancellation_companies__company_id__projects__project_id__orders__order_id__cancel_post
      parameters:
      - name: company_id
        in: path
        required: true
        schema:
          type: integer
          title: Company Id
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: order_id
        in: path
        required: true
        schema:
          type: integer
          title: Order Id
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/ChannableCancellationPayload'
              - type: 'null'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannableErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannableErrorResponse'
          description: Not Found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannableErrorResponse'
          description: Conflict
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/companies/{company_id}/projects/{project_id}/orders/{order_id}/manual:
    post:
      tags:
      - orders
      summary: Manual
      description: 'This endpoint allows you to indicate that the given order will be handled manually.

        Channable will no longer take any actions on the order after this operation has been performed.'
      operationId: manual_companies__company_id__projects__project_id__orders__order_id__manual_post
      parameters:
      - name: company_id
        in: path
        required: true
        schema:
          type: integer
          title: Company Id
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: order_id
        in: path
        required: true
        schema:
          type: integer
          title: Order Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannableErrorResponse'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v2/companies/{company_id}/projects/{project_id}/orders:
    get:
      tags:
      - orders
      summary: All Orders V2
      description: "This endpoint retrieves all orders for a given project of your company, sorted from most recent\nto oldest. Optionally, you can pass query parameters to customize the response content.\n\nNote that the order data itself (like address information) can not be modified.\n\n**Timezones**\n\nWhen using the `start_date`, `end_date`, `last_modified_after`, `last_modified_before`,\n`retrieved_at_start` or `retrieved_at_end` parameters please keep in mind that the we will\ninterpret the provided dates and times to be in UTC timezone.\n\nThe timestamps on the returned orders are ISO 8601 compliant and have a UTC offset of +00:00.\n\n**Example usage**\n\nSuppose the following scenario for a given project of yours:\n    - The project contains the orders `o1`, `o2`, `o3`, and `o4` (from oldest to most recent)\n    - `o3` contains some error\n    - `o1` and `o4` are searchable by the term `t`\n    - `o3` is searchable by the term `tE`\n\n|  Request parameters                          | Response\n| -------------                                | -----------\n| _none_                                  

# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/channable/refs/heads/main/openapi/channable-orders-api-openapi.yml