Get returns | feedonomics

curl https://marketplace-order-api.feedamp.feedonomics.com/api/v1/returns \
     -H "Authorization: Bearer <token>"

{
  "returns": [
    {
      "status": "AUTHORIZED",
      "rma": "RMA-12345",
      "mp_return_number": "RET-600A",
      "mp_order_number": "600A",
      "request_date": "2023-05-02",
      "respond_date": "2023-05-02",
      "shipping_address": {
        "full_name": "John M. Doe",
        "address1": "123 Fake Street",
        "city": "Ghost Town",
        "state": "DC",
        "postal_code": "91234",
        "country_code": "USA",
        "address_type": "business",
        "address2": "Building 456",
        "address3": "Room 789",
        "phone": "9997776666"
      },
      "customer_email": "customer@internet-provider.com",
      "return_type": "SHIP",
      "return_lines": [
        {
          "mp_return_line_number": "RETURN-XX-111-FF-1111",
          "mp_order_line_number": "XX-111-FF-1111",
          "sku": "1234-12353",
          "quantity": 1,
          "currency": "USD",
          "requested_refund_principal": 1.1,
          "reason": "Wrong color sent",
          "preauthorized": true,
          "product_name": "ACME Super Product",
          "unit_price": 1.1,
          "tax": 1.1,
          "requested_refund_tax": 1.1,
          "carrier": "UPS",
          "tracking_number": "XXX-DDD-XXXX-DDDD"
        }
      ],
      "merchant_refund_lines": [
        {
          "mp_return_line_number": "RETURN-XX-111-FF-1111",
          "principal_refund_amount": 1.1,
          "shipping_refund_amount": 1.1
        }
      ],
      "errors": [
        {
          "code": "EXCESS_REFUND",
          "message": "Requested refund amount for line exceeds line cost"
        }
      ]
    }
  ],
  "next_cursor": "12FDG-31dsfgHW"
}

Get all returns from FeedAMP, filtered by the provided query params

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

mp_order_numberslist of stringsOptional

Comma-delimited list of marketplace order numbers

mp_return_numberslist of stringsOptional

Comma-delimited list of marketplace return numbers

stateenumOptional

Filter by return processing state <ul>

AUTHORIZED - Return has been authorized

REFUNDED - The merchant has released the funds for the return

</ul>

Allowed values:

has_errorsbooleanOptional

Include returns either with or without errors. If not set, returns will be returned regardless of the presence/absence of errors

page_sizeintegerOptional10-50Defaults to 20

The number of returns per page to return

cursorstringOptional

Cursor for the next page of orders

Response

Order Returns

returnslist of objects

next_cursorstring

The cursor to get the next page of orders

Errors

400

Bad Request Error

401

Unauthorized Error