How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Channable orders API

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

Channable orders API is one of 6 APIs that Channable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

This API exposes 10 operations across 10 paths, and defines 54 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.channable.com/v1.

10 operations 10 paths 54 schemas 5 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.channable.com/v1
Resource Areas
1

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 5 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

orders 10
GET
/v1/companies/{company_id}/projects/{project_id}/ordersdeprecated
All Orders
all_orders_companies__company_id__projects__project_id__orders_get 15 params → 200422
GET
/v1/companies/{company_id}/projects/{project_id}/anonymous_orders
Anonymized All Orders
anonymized_all_orders_companies__company_id__projects__project_id__anonymous_orders_get 9 params → 200422
GET
/v1/companies/{company_id}/projects/{project_id}/orders/{order_id}deprecated
Single Order
single_order_companies__company_id__projects__project_id__orders__order_id__get 3 params → 200404422
POST
/v1/companies/{company_id}/projects/{project_id}/orders/{order_id}/return
Manual Return
manual_return_companies__company_id__projects__project_id__orders__order_id__return_post 3 params body → 200422
POST
/v1/companies/{company_id}/projects/{project_id}/orders/test/{order_config_id}
Create Test Order
create_test_order_companies__company_id__projects__project_id__orders_test__order_config_id__post 3 params body → 201422
POST
/v1/companies/{company_id}/projects/{project_id}/orders/{order_id}/shipment
Shipment
shipment_companies__company_id__projects__project_id__orders__order_id__shipment_post 3 params body → 200400404409422
POST
/v1/companies/{company_id}/projects/{project_id}/orders/{order_id}/cancel
Cancellation
cancellation_companies__company_id__projects__project_id__orders__order_id__cancel_post 3 params body → 200400404409422
POST
/v1/companies/{company_id}/projects/{project_id}/orders/{order_id}/manual
Manual
manual_companies__company_id__projects__project_id__orders__order_id__manual_post 3 params → 200404422
GET
/v2/companies/{company_id}/projects/{project_id}/orders
All Orders V2
all_orders_v2_v2_companies__company_id__projects__project_id__orders_get 13 params → 200504422
GET
/v2/companies/{company_id}/projects/{project_id}/orders/{order_id}
Single Order V2
single_order_v2_v2_companies__company_id__projects__project_id__orders__order_id__get 3 params → 200404422

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are EfferentOrder (23 properties), ChannableOrderDataProduct-Input (21 properties), ChannableOrderDataProduct-Output (21 properties), ChannableAPIOrder (19 properties). Each schema is shown below with its type and property counts.

EfferentOrderEvent
object
Differentiate EfferentOrderEvent to allow drift in the future
7 properties 6 required
TestOrderBody
object
7 properties
OrderEventStatus
string
ChannableOrderDataDeliveryRequest
object
4 properties
EfferentOrderDataExtra
object
5 properties 1 required
AnonymizedEfferentOrderDataCustomer
object
2 properties 1 required
AnonymizedEfferentOrderData
object
7 properties 7 required
ChannableAPIOrder
object
19 properties 10 required
AnonymizedEfferentOrderDataProduct
object
13 properties 5 required
RecentChannableAPIOrders
object
3 properties 3 required
ChannableOrderDataProduct-Input
object
21 properties 4 required
PlatformName
string
This Enum contains the names of all possible platforms.
ChannableOrderData
object
7 properties 5 required
OrderReturnBody
object
1 property 1 required
OrderConfigNameAndId
object
2 properties 2 required
OrderStatus
string
ManualReturnStatus
string
ChannableOrderDataProduct-Output
object
21 properties 4 required
Currency
string
This Enum contains all possible currencies.
OrderWithEvents
object
2 properties 2 required
AnonymizedRecentOrders
object
3 properties 3 required
ChannableOrderDataBillingAddress
object
19 properties
ChannelName
string
This Enum contains the names of all possible channels.
ChannableErrorResponse
object
The standard Channable error response
2 properties 1 required
OrderReturnProduct
object
3 properties 2 required
ChannableOrderPaymentStatus
string
ChannableOrderItemStatusEnum
string
Gender
string
This Enum contains all possible genders.
ResponseModelStatus
string
ValidationError
object
5 properties 3 required
ChannableOrderDataPrice-Input
object
10 properties 7 required
ChannableApiOrderEvent
object
Differentiate ChannableAPI order events to allow drift in the future
7 properties 6 required
OrderErrorReason
string
ChannableOrderDataExtra
object
8 properties 1 required
ResponseModel
object
A container for response model.
5 properties 2 required
ChannableCancellationPayload
object
1 property
OrderAttachmentEfferent
object
10 properties 6 required
OrderAttachmentType
string
OrderItemFulfillment
object
14 properties 5 required
ChannableOrderShipmentStatus
string
AnonymizedEfferentOrderDataAddress
object
5 properties
AnonymizedEfferentOrderDataPrice
object
8 properties 6 required
ChannableOrderDataPrice-Output
object
10 properties 7 required
FileExtensionOrderAttachments
string
EfferentOrder
object
23 properties 10 required
ChannableOrderDataShippingAddress
object
19 properties
ShippingResponseModel
object
A container for shipping response model.
6 properties 2 required
ChannableOrderDataCustomer
object
10 properties
HTTPValidationError
object
1 property
ChannableShippingPayload
object
Model for data obtained from the Channable API shipment update
5 properties
ChannableApiOrderWithEvents
object
2 properties 2 required
EfferentOrderDataDeliveryRequest
object
3 properties
AnonymizedEfferentOrder
object
An order representation from any channel to any platform, but with all PII filtered out of the data.
16 properties 10 required
RecentOrders
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

channable-orders-api-openapi.yml Raw ↑

Other APIs Channable publishes across the network.

Channable order_attachments API
Channable returns API
Channable statistics API
Channable stock_updates API
Channable transporters API
Where this information came from

This is an independent, third-party profile of Channable orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.