Get return | feedonomics

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

{
  "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"
    }
  ]
}

Get all seller-initiated refunds for an order

Authentication

AuthorizationBearer

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

Path parameters

mp_order_numberstringRequired

The unique Id for an order that is generated by the marketplace

mp_return_numberstringRequired

The unique Id for the return that is generated by the marketplace

Response

Get Return

statusenum

the return authorization number generated by the seller.

Allowed values:

rmastring1-128 characters

The return authorization number generated by the seller. This field is read-only for the marketplace.

mp_return_numberstring1-128 characters

the mp return number

mp_order_numberstring1-128 characters

the mp order number associated with the return

request_datedate

Date the return was requested. ISO 8601 DATE YYYY-MM-DD

respond_datedate

The date which the merchant must release the funds by

shipping_addressobject

customer_emailstring

The customer's email address

return_typeenum

How the items will be returned by the customer.

SHIP - the item will be shipped back by the customer
NO_RETURN - The customer will kep the item
IN_STORE - the item will be returned to the store by the customer (is only valid for V2)

Allowed values:

return_lineslist of objects

merchant_refund_lineslist of objects

errorslist of objects

Any unresolved errors reported by the marketplace for this return

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error