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 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.2.0, at version v1.

Requests are made against a single 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.2.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), AnonymizedEfferentReturnDataItem (6 properties), ChannableReturnsDataMeta (6 properties). Each schema is shown below with its type and property counts.

EfferentReturn
object
14 properties 11 required
AnonymizedRecentReturns
object
3 properties 3 required
ChannableReturnsPayload
object
Model for data obtained from the Channable API return status update
1 property 1 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
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…
TestReturnBody
object
1 property 1 required
AnonymizedEfferentReturnDataItem
object
6 properties 1 required
TestReturnResponse
object
3 properties 1 required
ChannableErrorResponse
object
The standard Channable error response
2 properties 1 required
AnonymizedEfferentReturnData
object
4 properties 3 required
SingleEfferentReturn
object
1 property 1 required
ResponseModelStatus
string
ValidationError
object
5 properties 3 required
AnonymizedEfferentReturnDataCustomer
object
1 property 1 required
ResponseModel
object
A container for response model.
5 properties 2 required
AnonymizedEfferentReturnDataAddress
object
4 properties
ChannableReturnsStatus
string
A container for channable return status. Based on the enum values of status column in the returns table.
UpdateReturnStatusResponse
object
2 properties 1 required
HTTPValidationError
object
1 property
RecentReturns
object
3 properties 3 required
ChannableReturnsDataMeta
object
6 properties 1 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
Where this information came from

This is an independent, third-party profile of Channable returns 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.