Get Orders

GET

https://marketplace-order-api.feedamp.feedonomics.com/api/v1/orders

GET

/api/v1/orders

curl -G https://marketplace-order-api.feedamp.feedonomics.com/api/v1/orders \
     -H "Authorization: Bearer <token>" \
     -d cursor=12FDG-31dsfgHW \
     -d has_errors=true

{
  "orders": [
    {
      "mp_order_number": "111-99998888-55555",
      "sales_channel": "Marketplace.com",
      "customer": {
        "full_name": "A. Customer",
        "email": "customer@internet-provider.com",
        "phone": "5558675309",
        "vat": "78131452263"
      },
      "purchase_date": {},
      "currency": "USD",
      "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"
      },
      "order_lines": [
        {
          "mp_line_number": "XX-111-FF-1111",
          "sku": "1234-12353",
          "product_name": "ACME Super Product",
          "quantity": 1,
          "unit_price": 200,
          "shipping_method": "Standard",
          "shipping_price": 1.95,
          "taxes": [
            {
              "type": "SHIPPING",
              "amount": 1.1
            }
          ],
          "discounts": [
            {
              "name": "Spring Discount",
              "amount": 1.1,
              "type": "ITEM"
            }
          ],
          "is_tax_collected_by_marketplace": false,
          "order_line_additional_properties": {}
        }
      ],
      "marketplace_state": "PENDING",
      "location": {
        "source_location_id": "a0b0c0-f-f-f-f00f",
        "client_location_id": "my-locid_00",
        "name": "City Store - Citiesville",
        "address": "1234 Street Ave., City Township, NJ 00000-0000"
      },
      "delivery_notes": "leave by the back door.",
      "earliest_ship_date": {},
      "latest_ship_date": {},
      "latest_delivery_date": {},
      "earliest_delivery_date": {},
      "gift_message": "Happy birthday!",
      "marketing_opt_in": false,
      "billing_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"
      },
      "order_additional_properties": {},
      "is_marketplace_fulfilled": false,
      "fulfillment_type": "shipment"
    }
  ],
  "next_cursor": "12FDG-31dsfgHW"
}

Get all orders from FeedAMP for a seller, 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

fulfillment_statuslist of enumsOptional

Comma-delimited list of fulfillment statuses

UNFULFILLED returns orders that are AWAITING_SHIPMENT with no fulfillments
PARTIALLY_FULFILLED returns orders that are AWAITING_SHIPMENT and have at least one fulfillment
COMPLETE returns orders that have all of their fulfillments, and have been marked SHIPPED or CANCELLED

Allowed values:

imported_afterdatetimeOptional

Include orders imported on or after this date (format ISO 8601 default time zone is America/New_York)

seller_updated_afterdatetimeOptional

Include orders updated by the seller on or after this date (format ISO 8601 default time zone is America/New_York)

has_errorsbooleanOptional

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

page_sizeintegerOptional10-50Defaults to 20

The number of orders per page to return

cursorstringOptional

Cursor for the next page of orders

Response

Get Orders

orderslist of objects

next_cursorstringOptional

The cursor to get the next page of orders

Errors

400

Bad Request Error

401

Unauthorized Error