Get an individual return | feedonomics

curl https://api.feedamp.feedonomics.com/api/v2/returns/109872189273617283 \
     -H "token: token" \
     -H "client: 1" \
     -u "<username>:<password>"

{
  "id": "109872189273617283",
  "marketplace_return_number": "111-99998888-55555",
  "imported_date": "2020-12-31T12:34:56-05:00",
  "return_lines": [
    {
      "id": "109872189273617283",
      "marketplace_return_line_number": "XX-111-FF-1111",
      "marketplace_order_line_number": "XX-111-FF-1111",
      "feedamp_order_line_id": "109872189273617283",
      "sku": "1234-12353",
      "product_name": "ACME Super Product",
      "quantity": 1,
      "unit_price": 200,
      "reason": "Not what I ordered",
      "original_price": 1.95,
      "requested_refund": 1.95,
      "shipping_expected": false,
      "destination": "string",
      "label_cost": 1.95,
      "tracking_info": {
        "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'",
        "tracking_number": "string"
      }
    }
  ],
  "order_id": "109872189273617283",
  "integration_name": "My Store",
  "marketplace_name": "Target",
  "rma": "1234567890",
  "merchant_return_number": "1234567890",
  "marketplace_order_number": "000-1234567-7654321",
  "marketplace_state": "Shipped",
  "normalized_marketplace_state": "string",
  "pre_authorized": true,
  "customer": {
    "full_name": "A. Customer",
    "email": "customer@internet-provider.com",
    "phone": "5558675309",
    "vat": "78131452263"
  },
  "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": {
    "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",
    "country_code_iso2": "US",
    "phone": "9997776666"
  },
  "return_type": "SHIP"
}

Get a return identified for the specified return-id

Authentication

AuthorizationBasic

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

Path parameters

return-idstringRequired

FeedAMP Return ID

Query parameters

include_orderbooleanOptional

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

Response

The return

idstring

Unique identifier for a record

marketplace_return_numberstring1-128 characters

The primary return number used to identify the return in the marketplace's system

imported_datedatetime

The datetime at which the order was first seen by FeedAMP. RFC-3339 format 2020-12-31T12:34:56-05:00

return_lineslist of objects

A collection of ReturnLine objects.

order_idstring

Identifier for the order this return is for, if applicable

integration_namestring

Client-configured identifier for the integration from which the order originated

marketplace_namestring

The platform from which the order originated

rmastring1-128 characters

RMA ID of the return

merchant_return_numberstring1-128 characters

Return identifier provided by the merchant, separately from RMA

marketplace_order_numberstring>=1 character

Order number of the order associated with this return

marketplace_statestring

The marketplace's own representation of the return state

normalized_marketplace_statestring

FeedAMP's interpretation of the marketplace state

pre_authorizedboolean

Whether customer returns are assumed to be authorized by the merchant

customerobject

request_datedatetime

Date the customer initiated the return. RFC-3339 format 2020-12-31T12:34:56-05:00

respond_by_datedatetime

Date by which the seller must respond to the return request. RFC-3339 format 2020-12-31T12:34:56-05:00

notesstring

The customer's notes about the return.

shipping_addressobject

Customer's Shipping Information

return_typeenum

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors