For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocsAPI ReferenceChangelog
DocsAPI ReferenceChangelog
  • REST
    • Authentication
    • Platform
    • Event-Driven Sync (EDRTS)
    • Content
    • FeedAMP Order
    • FeedAMP Order V2
          • GETList all cancellations on an order
          • POSTCreate a cancellation on an order
          • GETGet details of a single cancellation
          • PUTUpdate details of a cancellation
          • DELDelete a cancellation
    • FeedAMP Order Source
LogoLogo
RESTFeedAMP Order V2Cancellations

Get details of a single cancellation

GET
https://api.feedamp.feedonomics.com/api/v2/orders/:order-id/cancellations/:cancellation-id
GET
/api/v2/orders/:order-id/cancellations/:cancellation-id
$curl https://api.feedamp.feedonomics.com/api/v2/orders/109872189273617283/cancellations/109872189273617283 \
>     -H "token: token" \
>     -H "client: 1" \
>     -u "<username>:<password>"
1{
2  "id": "109872189273617283",
3  "cancellation_lines": [
4    {
5      "line_id": "109872189273617283",
6      "quantity": 1
7    }
8  ],
9  "reason": "customer_cancelled"
10}
Get the information for the specified cancellation in the specified order
Was this page helpful?
Previous

Create a cancellation on an order

Next

Update details of a cancellation

Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

order-idstringRequired
FeedAMP Order ID
cancellation-idstringRequired
FeedAMP Cancellation ID

Headers

tokenstringRequired

The Authentication token obtained from the v1 get_token route

clientintegerRequired
The ID of the client making the request

Response

Cancellation details
idstring
Unique identifier for a record
cancellation_lineslist of objects
reasonenum
Reason provided for the order line's cancellation

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error