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 orders. 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.1.0, at version v1.
Requests are made against the base URL https://api.channable.com/v1.
10 operations10 paths54 schemas5 GET5 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.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.
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), ChannableOrderDataBillingAddress (19 properties). Each schema is shown below with its type and property counts.
ChannableOrderDataDeliveryRequest
object
4 properties
PlatformName
string
This Enum contains the names of all possible platforms.
ManualReturnStatus
string
ChannableOrderDataBillingAddress
object
19 properties
EfferentOrderDataDeliveryRequest
object
3 properties
ChannelName
string
This Enum contains the names of all possible channels.
RecentOrders
object
4 properties4 required
ValidationError
object
5 properties3 required
ChannableOrderDataShippingAddress
object
19 properties
OrderAttachmentType
string
OrderWithEvents
object
2 properties2 required
ChannableCancellationPayload
object
1 property
TestOrderBody
object
7 properties
ChannableOrderItemStatusEnum
string
HTTPValidationError
object
1 property
OrderAttachmentEfferent
object
10 properties6 required
OrderStatus
string
Currency
string
This Enum contains all possible currencies.
EfferentOrderEvent
object
Differentiate EfferentOrderEvent to allow drift in the future
7 properties6 required
AnonymizedEfferentOrderData
object
7 properties7 required
EfferentOrderDataExtra
object
5 properties1 required
ChannableApiOrderWithEvents
object
2 properties2 required
AnonymizedEfferentOrderDataAddress
object
5 properties
OrderReturnBody
object
1 property1 required
AnonymizedEfferentOrderDataCustomer
object
2 properties1 required
ChannableOrderDataPrice-Input
object
10 properties7 required
EfferentOrder
object
23 properties10 required
ChannableOrderDataExtra
object
8 properties1 required
OrderItemFulfillment
object
14 properties5 required
ChannableErrorResponse
object
The standard Channable error response
2 properties1 required
OrderEventStatus
string
RecentChannableAPIOrders
object
3 properties3 required
ChannableShippingPayload
object
Model for data obtained from the Channable API shipment update
5 properties
Gender
string
This Enum contains all possible genders.
ChannableApiOrderEvent
object
Differentiate ChannableAPI order events to allow drift in the future
7 properties6 required
AnonymizedEfferentOrderDataProduct
object
13 properties5 required
ChannableOrderDataCustomer
object
10 properties
ChannableOrderDataProduct-Input
object
21 properties4 required
AnonymizedEfferentOrder
object
An order representation from any channel to any platform, but with all PII filtered out of the data.
16 properties10 required
ResponseModel
object
A container for response model.
5 properties2 required
ShippingResponseModel
object
A container for shipping response model.
6 properties2 required
ResponseModelStatus
string
ChannableOrderPaymentStatus
string
AnonymizedEfferentOrderDataPrice
object
8 properties6 required
ChannableOrderData
object
7 properties5 required
OrderErrorReason
string
ChannableOrderDataPrice-Output
object
10 properties7 required
AnonymizedRecentOrders
object
3 properties3 required
ChannableOrderShipmentStatus
string
ChannableOrderDataProduct-Output
object
21 properties4 required
ChannableAPIOrder
object
19 properties10 required
FileExtensionOrderAttachments
string
OrderReturnProduct
object
3 properties2 required
OrderConfigNameAndId
object
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
