logo
API docs by Redocly

FeedAMP Flexible Workflow API (2.0.17)

E-mail: feedamp@feedonomics.com

The Flexible Order Workflow is a new beta Order solution, which provides enhanced control over your order processing by allowing you to define how orders are managed, fulfilled, and updated. This event-driven system adapts to your existing processes, giving you the flexibility to automate workflows according to your specific requirements.

What You'll Learn:

  • How to authenticate and manage API access.
  • Defining events and order processes.
  • Submitting fulfillments at the item level.
  • Processing returns and refunds.
  • Managing cancellations and refunds.

FeedAMP Flexible Workflow

FeedAMP Flexible Workflow is an event-driven order processing system. Orders are imported from marketplaces on a configurable schedule, generating a new-order event. After this, your workflow configuration determines all the actions that are taken on that order.

Authentication

FeedAMP Flexible Workflow currently uses the same authentication endpoints and headers as the FeedAMP v1 API.

New features since FeedAMP API v1

  • Request orders with PENDING marketplace state
  • Request orders filtered by the last time the marketplace state changed
  • Submit individual item fulfillments and cancellations, instead of needing to consolidate the whole order for every submission
  • Invoke channel-specific operations outside of the typical FeedAMP order workflow.

Example call structure

  1. Call GET /get_token with your username and password in Basic Authentication to get an auth token. Save this token until it expires and use it in all your requests.
  2. Fetching orders
  3. Fulfill order lines
    • Pack items and note which order lines and quantities are in each package.
    • Call POST /orders/{order_id}/fulfillments with Fulfillment model
      { "fulfillment_type": "shipment", "fulfillment_lines": [ { "line_id": "1", "quantity": 1 }, { "line_id":"2", "quantity": 2 } ], "shipment": { "shipped_date": "2020-01-01T12:34:56-05:00", "carrier": "UPS", "tracking_number": "1Z123XYZ" } }
    • Flexible workflow can be configured in FeedAMP to immediately send individual shipments to supported marketplaces.
  4. Cancel order lines
    • Call POST /orders/{order_id}/cancellations with Cancellation model
      { "cancellation_lines": [ { "line_id": "3", "quantity": 3 }, { "line_id": "4", "quantity": 4 } ], "reason": "out_of_stock" }
    • Flexible workflow can be configured in FeedAMP to immediately send individual cancellations to supported marketplaces.
  5. When all the items in the order have been fulfilled or cancelled, workflow can be configured to send whole-order fulfillment to supported marketplaces.

Additional Notes

It is expected that Rest API integrations are able to tolerate additive (i.e. non-breaking) updates without requiring advance notice.

Authentication

Authentication for users to access API

Get an authentication token

Use your username/password and HTTP Basic Authentication to get an authentication token Use the token along with your client id in all subsequent requests. When the token expires make another request to this route and get a new token.

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "token": "53bf15c-this-is-an-example-token-b7769e17d-example-3f82af26f-example-12588b14d-example-15426324a-example-a5b2f721c-example-26fc7"
}

Orders

Retrieve and interact with orders in the system

Get orders filtered by search parameters

Get all orders that match the parameters that you have submitted. The maximum recommended call frequency for retrieving data from this endpoint is 2 requests per second.

Authorizations:
BasicAuth
query Parameters
marketplace_state
string

The state of the order. Multiple states can be matched by specifying a comma-separated list of values.

normalized_marketplace_state
string
Enum: "PENDING" "AWAITING_ACKNOWLEDGEMENT" "AWAITING_SHIPMENT" "SHIPPED" "CANCELLED"

FeedAMP's understanding of the state of the order in the marketplace. Multiple states can be matched by specifying a comma-separated list of values.

marketplace_state_changed_after
string <date-time> (DateTime)
Example: marketplace_state_changed_after=2024-03-13T08:50:59-08:00

Marketplace state was last changed after this datetime. RFC-3339 date-time format — fractional seconds not allowed

marketplace_state_changed_before
string <date-time> (DateTime)
Example: marketplace_state_changed_before=2024-03-13T08:50:59-08:00

Marketplace state was last changed before this datetime. RFC-3339 date-time format — fractional seconds not allowed

imported_after
string <date-time> (DateTime)
Example: imported_after=2024-03-13T08:50:59-08:00

Orders created in FeedAMP after this datetime. RFC-3339 date-time format — fractional seconds not allowed

imported_before
string <date-time> (DateTime)
Example: imported_before=2024-03-13T08:50:59-08:00

Orders created in FeedAMP before this datetime. RFC-3339 date-time format — fractional seconds not allowed

id
string

FeedAMP order ID. May be a comma-delimited list of multiple IDs.

marketplace_order_number
string

The primary order number provided by the marketplace. May be a comma-delimited list of multiple

customer_order_number
string

The customer-facing order number provided by the marketplace. May be a comma-delimited list of multiple

integration_id
string (IdField)
Example: integration_id=109872189273617283

FeedAMP integration ID to limit results to a single integration

source_location_id
string

Source platform identifier for a location to limit order results to

client_location_id
string

Client-provided identifier for a location to limit order results to. This will take precedence over source_location_id if both are present in the request.

feedamp_status
string
Example: feedamp_status=FULFILLMENT_REPORTED

The feedamp order status

limit
integer [ 1 .. 250 ]
Default: 100

The max number of orders in the response.

cursor
string

Cursor for the next page of orders.

include_raw_data
boolean
Default: false

Set true to include the raw data from the marketplace for each order in results.

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "next_cursor": "string"
}

Get order by {order-id}

A single order model

Authorizations:
BasicAuth
path Parameters
order-id
required
integer <int64>

The id of the order

query Parameters
include_raw_data
boolean
Default: false

Set true to include the raw data from the marketplace for each order in results.

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
{
  • "id": "109872189273617283",
  • "marketplace_order_number": "111-99998888-55555",
  • "customer_order_number": "000-1234567-7654321",
  • "marketplace_name": "Target",
  • "integration_name": "My Store",
  • "sales_channel": "Marketplace.co.uk",
  • "location": {
    },
  • "customer": {
    },
  • "imported_date": "2020-12-31T12:34:56-05:00",
  • "purchase_date": "2020-12-31T12:34:56-05:00",
  • "currency": "USD",
  • "delivery_notes": "leave by the back door.",
  • "earliest_ship_date": "2020-12-31T12:34:56-05:00",
  • "latest_ship_date": "2020-12-31T12:34:56-05:00",
  • "latest_delivery_date": "2020-12-31T12:34:56-05:00",
  • "earliest_delivery_date": "2020-12-31T12:34:56-05:00",
  • "gift_message": "Happy birthday!",
  • "marketing_opt_in": false,
  • "shipping_address": {
    },
  • "billing_address": {
    },
  • "order_lines": [
    ],
  • "order_additional_properties": { },
  • "workflow_status": "FULFILLMENT REPORTED",
  • "marketplace_state": "Shipped",
  • "normalized_marketplace_state": "PENDING",
  • "is_marketplace_fulfilled": false,
  • "marketplace_state_changed_at": "2020-12-31T12:34:56-05:00",
  • "fulfillment_type": "shipment"
}

Run an operation on an order

Run the operation specified in the request on an order. The contents of the request and response will vary depending on the operation.

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

query Parameters
op
required
string
Example: op=acknowledge

Name of the operation to run

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Request Body schema: application/json
optional

The contents of the request and response will vary depending on the operation.

object or null

Responses

Request samples

Content type
application/json
Example

Confirm to the marketplace that merchant has received the order. The operation has no request body

null

Response samples

Content type
application/json
{
  • "operation": "string",
  • "response": { }
}

Fulfillments

Create, retrieve and interact with fulfillments in the system

Create a fulfillment on an order

Post a shipment for a specific set of items

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Request Body schema: application/json
One of
fulfillment_type
required
string
Value: "shipment"
required
object
shipped_date
required
string <date-time>

Date and time the shipment was created. RFC-3339 format 2020-12-31T12:34:56-05:00

carrier
required
string (Carrier)

Carrier used by seller for shipping. Any string will be accepted, see examples for preferred spellings of common carriers.

tracking_number
required
string

Tracking number provided by Carrier for the shipment

tracking_url
string <url>
state
string
Value: "shipped"
required
Array of objects (LineQuantity)

Specification of order lines and quantities contained in the shipment

Array
line_id
required
string (IdField)

Unique identifier for a record

quantity
required
integer >= 1

Responses

Request samples

Content type
application/json
Example
{
  • "fulfillment_type": "shipment",
  • "shipment": {
    },
  • "state": "shipped",
  • "fulfillment_lines": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "fulfillment_type": "shipment",
  • "shipment": {
    },
  • "state": "shipped",
  • "id": "109872189273617283",
  • "fulfillment_lines": [
    ]
}

List fulfillments on an order

Get all fulfillment information for the specified order

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

query Parameters
tracking_number
string

Fulfillments matching the given tracking number

carrier
string (Carrier)
Example: carrier= '4PX', 'A-1', 'AAA Cooper', 'ABF', 'Asendia', 'Best Buy', 'Blue Package', 'Canada Post', 'CEVA', 'China Post', 'Conway', 'DHL', 'DHL eCommerce', 'Estes', 'FedEx', 'Fedex Freight', 'FedEx SmartPost', 'First Mile', 'Hongkong Post', 'Hunter Logistics', 'India Post', 'JCEX', 'Lasership', 'Newgistics', 'Old Dominion', 'OnTrac', 'OSM', 'Pilot Freight', 'R+L', 'Roadrunner', 'Royal Mail', 'Saia', 'SF Express', 'SFC', 'Singapore Post', 'South Eastern Freight Lines', 'Streamlite', 'UPS', 'UPS Freight', 'UPS Mail Innovations', 'Urban Express', 'USPS', 'WanbExpress', 'Watkins and Shepard', 'YANWEN', 'Yellow Freight', 'Yun Express', 'Other'

Fulfillments matching the given carrier

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
{
  • "fulfillments": [
    ]
}

Get details of a single fulfillment

Get the information for the specified fulfillment in the specified order

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

fulfillment-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Fulfillment ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
Example
{
  • "fulfillment_type": "shipment",
  • "shipment": {
    },
  • "state": "shipped",
  • "id": "109872189273617283",
  • "fulfillment_lines": [
    ]
}

Update details of a fulfillment

Update the details of the specified fulfillment in the specified order

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

fulfillment-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Fulfillment ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Request Body schema: application/json
One of
fulfillment_type
required
string
Value: "shipment"
required
object
shipped_date
required
string <date-time>

Date and time the shipment was created. RFC-3339 format 2020-12-31T12:34:56-05:00

carrier
required
string (Carrier)

Carrier used by seller for shipping. Any string will be accepted, see examples for preferred spellings of common carriers.

tracking_number
required
string

Tracking number provided by Carrier for the shipment

tracking_url
string <url>
state
string
Value: "shipped"
required
Array of objects (LineQuantity)

Specification of order lines and quantities contained in the shipment

Array
line_id
required
string (IdField)

Unique identifier for a record

quantity
required
integer >= 1

Responses

Request samples

Content type
application/json
Example
{
  • "fulfillment_type": "shipment",
  • "shipment": {
    },
  • "state": "shipped",
  • "fulfillment_lines": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "fulfillment_type": "shipment",
  • "shipment": {
    },
  • "state": "shipped",
  • "id": "109872189273617283",
  • "fulfillment_lines": [
    ]
}

Delete a fulfillment

Delete the specified fulfillment in the specified order

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

fulfillment-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Fulfillment ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
Example

Token header is missing

{
  • "error": "Missing token."
}

Cancellations

Create, retrieve and interact with cancellations in the system

Create a cancellation on an order

Post a cancellation of line item

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Request Body schema: application/json
required
Array of objects (LineQuantity)
Array
line_id
required
string (IdField)

Unique identifier for a record

quantity
required
integer >= 1
reason
required
string (CancellationReason)
Enum: "customer_cancelled" "customer_rejected" "unable_to_ship" "out_of_stock" "price_error" "tax_error" "shipping_price_error" "fraud" "other"

Reason provided for the order line's cancellation

Responses

Request samples

Content type
application/json
{
  • "cancellation_lines": [
    ],
  • "reason": "customer_cancelled"
}

Response samples

Content type
application/json
{
  • "id": "109872189273617283",
  • "cancellation_lines": [
    ],
  • "reason": "customer_cancelled"
}

List all cancellations on an order

Get all the cancellations for the specified order

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
{
  • "cancellations": [
    ]
}

Get details of a single cancellation

Get the information for the specified cancellation in the specified order

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

cancellation-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Cancellation ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
{
  • "id": "109872189273617283",
  • "cancellation_lines": [
    ],
  • "reason": "customer_cancelled"
}

Update details of a cancellation

Update the information for a specified cancellation in the specified order

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

cancellation-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Cancellation ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Request Body schema: application/json
required
Array of objects (LineQuantity)
Array
line_id
required
string (IdField)

Unique identifier for a record

quantity
required
integer >= 1
reason
required
string (CancellationReason)
Enum: "customer_cancelled" "customer_rejected" "unable_to_ship" "out_of_stock" "price_error" "tax_error" "shipping_price_error" "fraud" "other"

Reason provided for the order line's cancellation

Responses

Request samples

Content type
application/json
{
  • "cancellation_lines": [
    ],
  • "reason": "customer_cancelled"
}

Response samples

Content type
application/json
{
  • "id": "109872189273617283",
  • "cancellation_lines": [
    ],
  • "reason": "customer_cancelled"
}

Delete a cancellation

Delete the specified cancellation in the specified order

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

cancellation-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Cancellation ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
Example

Token header is missing

{
  • "error": "Missing token."
}

Refunds

Retrieve and process seller initiated refunds

Create a refund adjustment on an order

Post a refund to a line item

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Request Body schema: application/json
cp_refund_number
required
string

Seller Refund ID. Must be unique for all posted refunds.

required
Array of objects (RefundLine)
Array
feedamp_order_line_id
required
string (IdField)

Unique identifier for a record

refund_reason
required
string
Enum: "customer_cancelled" "unable_to_ship" "out_of_stock" "price_error" "tax_error" "shipping_price_error" "fraud" "other"

The reason for the refund. Please see Enum for accepted values. Use of 'other' is not recommended - some marketplaces may not accept it. If set to 'other', it is strongly recommended to enter a description in the 'refund_notes' field.

refund_line_number
string

The merchant's unique identifier for this refund item

refund_quantity
integer

The quantity of items being fully refunded.

currency
string (ISOCurrencyCodes)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "CNY" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLE" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UYW" "UZS" "VED" "VES" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"

ISO 4217 Currency codes

item_refund
number

The amount of item principal to be refunded

item_tax_refund
number

The amount of item tax to be refunded, if required by the marketplace

shipping_refund
number

The amount of shipping to be refunded

shipping_tax_refund
number

The amount of shipping tax to be refunded, if required by the marketplace

discount_refund
number

The discount amount being refunded/undone.

refund_notes
string

Additional information to convey to the marketplace or buyer

property name*
additional property
any
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "cp_refund_number": "REFUND-1234",
  • "refund_lines": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "109872189273617283",
  • "cp_refund_number": "REFUND-1234",
  • "refund_lines": [
    ]
}

List all refunds on an order

Get all the refund adjustments created for the specifed order

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
{
  • "cancellations": [
    ]
}

Get details of a single refund

Get the details for the specified refund adjustment on the specifed order

Authorizations:
BasicAuth
path Parameters
order-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Order ID

refund-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Refund ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
{
  • "id": "109872189273617283",
  • "cp_refund_number": "REFUND-1234",
  • "refund_lines": [
    ]
}

Apply a refund on an return

Post a refund to a return item request

Authorizations:
BasicAuth
path Parameters
return-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Return ID

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Request Body schema: application/json
required
Array of objects (ReturnRefundLine)
Array
feedamp_return_line_id
required
string (IdField)

Unique identifier for a record

item_refund
number

The amount of item principal to be refunded

shipping_refund
number

The amount of shipping to be refunded

refund_notes
string

Additional information to convey to the marketplace or buyer

merchant_full_refund
boolean

Apply the full requested refund amount to the returned item

Responses

Request samples

Content type
application/json
{
  • "merchant_refund_lines": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "109872189273617283",
  • "merchant_refund_lines": [
    ]
}

Returns

Retrieve and process customer returns

Get returns filtered by search parameters

Get all returns that match the parameters that you have submitted. The maximum recommended call frequency for retrieving data from this endpoint is 2 requests per second.

Authorizations:
BasicAuth
query Parameters
marketplace_state
string

The state of the return. Multiple states can be matched by specifying a comma-separated list of values.

marketplace_state_changed_after
string <date-time> (DateTime)
Example: marketplace_state_changed_after=2024-03-13T08:50:59-08:00

Marketplace state was last changed after this datetime. RFC-3339 date-time format — fractional seconds not allowed

marketplace_state_changed_before
string <date-time> (DateTime)
Example: marketplace_state_changed_before=2024-03-13T08:50:59-08:00

Marketplace state was last changed before this datetime. RFC-3339 date-time format — fractional seconds not allowed

imported_after
string <date-time> (DateTime)
Example: imported_after=2024-03-13T08:50:59-08:00

Returns created in FeedAMP after this datetime. RFC-3339 date-time format — fractional seconds not allowed

imported_before
string <date-time> (DateTime)
Example: imported_before=2024-03-13T08:50:59-08:00

Returns created in FeedAMP before this datetime. RFC-3339 date-time format — fractional seconds not allowed

id
string

FeedAMP return ID. May be a comma-delimited list of multiple IDs.

marketplace_return_number
string

The primary return ID provided by the marketplace. May be a comma-delimited list of multiple values.

rma
string

RMA ID of a return. May be a comma-delimited list of multiple values.

customer_order_number
string

The customer-facing order number associated with this return. May be a comma-delimited list of multiple values.

return_type
string (ReturnTypes)
Enum: "SHIP" "IN_STORE" "NO_RETURN"

Filter returns by the return type

integration_id
string (IdField)
Example: integration_id=109872189273617283

FeedAMP integration ID to limit results to a single integration

limit
integer [ 1 .. 250 ]
Default: 100

The max number of records in the response

cursor
string

Cursor for the next page of records

include_order
boolean

Include the order data, associated with the return, in response

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
{
  • "returns": [
    ],
  • "next_cursor": "string"
}

Get an individual return

Get a return identified for the specified return-id

Authorizations:
BasicAuth
path Parameters
return-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Return ID

query Parameters
include_order
boolean

Include the order data, associated with the return, in response

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Responses

Response samples

Content type
application/json
{
  • "id": "109872189273617283",
  • "order_id": "109872189273617283",
  • "integration_name": "My Store",
  • "marketplace_name": "Target",
  • "marketplace_return_number": "111-99998888-55555",
  • "rma": "1234567890",
  • "merchant_return_number": "1234567890",
  • "marketplace_order_number": "000-1234567-7654321",
  • "marketplace_state": "Shipped",
  • "normalized_marketplace_state": "string",
  • "pre_authorized": true,
  • "customer": {
    },
  • "imported_date": "2020-12-31T12:34:56-05:00",
  • "request_date": "2020-12-31T12:34:56-05:00",
  • "respond_by_date": "2020-12-31T12:34:56-05:00",
  • "notes": "leave by the back door.",
  • "shipping_address": {
    },
  • "return_lines": [
    ],
  • "return_type": "SHIP"
}

Run an operation on an return

Run the operation specified in the request on an return. The contents of the request and response will vary depending on the operation.

Authorizations:
BasicAuth
path Parameters
return-id
required
string (IdField)
Example: 109872189273617283

FeedAMP Return ID

query Parameters
op
required
string
Example: op=process

Name of the operation to run

header Parameters
token
required
string

The Authentication token obtained from the v1 get_token route

client
required
integer

The ID of the client making the request

Request Body schema: application/json
optional

The contents of the request and response will vary depending on the operation.

object or null

Responses

Request samples

Content type
application/json

Authorize customer return to the marketplace

null

Response samples

Content type
application/json
{
  • "operation": "string",
  • "response": { }
}