Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Channable returns API

The returns API from Channable — 5 operation(s) for returns.

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

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

This API exposes 5 operations across 5 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against the base URL https://api.channable.com/v1.

5 operations 5 paths 21 schemas 3 GET2 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 5

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

returns 5
GET
/v1/companies/{company_id}/projects/{project_id}/returns
All Returns
all_returns_companies__company_id__projects__project_id__returns_get 13 params → 200422
GET
/v1/companies/{company_id}/projects/{project_id}/anonymous_returns
Anonymized All Returns
anonymized_all_returns_companies__company_id__projects__project_id__anonymous_returns_get 8 params → 200422
GET
/v1/companies/{company_id}/projects/{project_id}/returns/{return_id}
Single Return
single_return_companies__company_id__projects__project_id__returns__return_id__get 3 params → 200422
POST
/v1/companies/{company_id}/projects/{project_id}/returns/test
Create Test Return
create_test_return_companies__company_id__projects__project_id__returns_test_post 1 param body → 201400404409422
POST
/v1/companies/{company_id}/projects/{project_id}/returns/{return_id}/status
Update Return Status
update_return_status_companies__company_id__projects__project_id__returns__return_id__status_post 3 params body → 200409422

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are EfferentReturn (14 properties), AnonymizedEfferentReturn (13 properties), ChannableReturnsDataMeta (6 properties), AnonymizedEfferentReturnDataItem (6 properties). Each schema is shown below with its type and property counts.

SingleEfferentReturn
object
1 property 1 required
ValidationError
object
5 properties 3 required
AnonymizedEfferentReturnDataAddress
object
4 properties
ChannableReturnsPayload
object
Model for data obtained from the Channable API return status update
1 property 1 required
HTTPValidationError
object
1 property
AnonymizedEfferentReturnDataCustomer
object
1 property 1 required
UpdateReturnStatusResponse
object
2 properties 1 required
ChannableApiReturnsStatus
string
A container for channable api return status. This is similar to realtime2.models.returns.ChannableReturnsStatus but is missing a few statuses (new, manual, and…
ChannableErrorResponse
object
The standard Channable error response
2 properties 1 required
ChannableReturnsDataMeta
object
6 properties 1 required
AnonymizedEfferentReturnDataItem
object
6 properties 1 required
ChannableReturnsStatus
string
A container for channable return status. Based on the enum values of status column in the returns table.
TestReturnBody
object
1 property 1 required
ResponseModel
object
A container for response model.
5 properties 2 required
TestReturnResponse
object
3 properties 1 required
ResponseModelStatus
string
RecentReturns
object
3 properties 3 required
EfferentReturn
object
14 properties 11 required
AnonymizedEfferentReturnData
object
4 properties 3 required
AnonymizedRecentReturns
object
3 properties 3 required
AnonymizedEfferentReturn
object
A return representation from any channel to any platform, but with all PII filtered out of the data.
13 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

channable-returns-api-openapi.yml Raw ↑

Other APIs Channable publishes across the network.

Channable order_attachments API
Channable orders API
Channable statistics API
Channable stock_updates API
Channable transporters API