Get orders filtered by search parameters

curl -G https://api.feedamp.feedonomics.com/api/v2/orders \
     -H "client: 1" \
     -H "token: <apiKey>" \
     -d feedamp_status=SENT_FOR_FULFILLMENT \
     --data-urlencode feedamp_status_changed_after=2024-03-13T08:50:59-08:00 \
     --data-urlencode feedamp_status_changed_before=2024-03-13T08:50:59-08:00 \
     --data-urlencode imported_after=2024-03-13T08:50:59-08:00 \
     --data-urlencode imported_before=2024-03-13T08:50:59-08:00 \
     -d integration_id=109872189273617283 \
     --data-urlencode marketplace_state_changed_after=2024-03-13T08:50:59-08:00 \
     --data-urlencode marketplace_state_changed_before=2024-03-13T08:50:59-08:00

{
  "orders": [
    {
      "id": "109872189273617283",
      "marketplace_order_number": "111-99998888-55555",
      "customer": {
        "full_name": "A. Customer",
        "email": "customer@internet-provider.com",
        "phone": "5558675309",
        "vat": "78131452263"
      },
      "imported_date": {},
      "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",
        "country_code_iso2": "US",
        "phone": "9997776666"
      },
      "order_lines": [
        {
          "id": "109872189273617283",
          "marketplace_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"
            }
          ],
          "platform_discount": 5.5,
          "commission": 2.5,
          "gift_wrap_price": 5.99,
          "gift_wrap_tax": 0.3,
          "is_tax_collected_by_marketplace": false,
          "order_line_additional_properties": {}
        }
      ],
      "marketplace_state": "Shipped",
      "customer_order_number": "000-1234567-7654321",
      "merchant_order_number": "12345",
      "marketplace_name": "Target",
      "integration_name": "My Store",
      "sales_channel": "Marketplace.co.uk",
      "location": {
        "source_location_id": "a0b0c0-f-f-f-f00f",
        "name": "City Store - Citiesville",
        "active": true,
        "client_location_id": "my-locid_00",
        "address": "1234 Street Ave., City Township, NJ 00000",
        "custom_fields": {}
      },
      "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",
        "country_code_iso2": "US",
        "phone": "9997776666"
      },
      "order_additional_properties": {},
      "payment_gateway_transactions": [
        {
          "id": "id",
          "amount": 10,
          "currency": "USD",
          "gateway_transaction_id": "12345",
          "gateway": "stripe"
        }
      ],
      "workflow_status": "SENT_FOR_FULFILLMENT",
      "normalized_marketplace_state": "PENDING",
      "is_marketplace_fulfilled": false,
      "marketplace_state_changed_at": {},
      "fulfillment_type": "shipment",
      "shipment_service_level": "UPS_GROUND",
      "shipment_node": "Austin Warehouse"
    }
  ],
  "next_cursor": "string"
}

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.

Authentication

tokenstring

The Authentication token obtained from the get_token route.

x-api-keystring

The SSO token obtained from the Feedonomics platform SSO token route.

Query parameters

marketplace_statestringOptional

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

normalized_marketplace_stateenumOptional

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.

Allowed values:

marketplace_state_changed_afterdatetimeOptional

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

marketplace_state_changed_beforedatetimeOptional

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

imported_afterdatetimeOptional

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

imported_beforedatetimeOptional

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

idstringOptional

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

marketplace_order_numberstringOptional

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

customer_order_numberstringOptional

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

merchant_order_numberstringOptional

Order identifier in the merchant’s e-commerce platform. May be a comma-delimited list of multiple

integration_idstringOptional

FeedAMP integration ID to limit results to a single integration

source_location_idstringOptional

Source platform identifier for a location to limit order results to

client_location_idstringOptional

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_statusenumOptional

The feedamp order status

Allowed values:

feedamp_status_changed_afterdatetimeOptional

Feedamp order status was last changed after this datetime. RFC-3339 date-time format — fractional seconds not allowed

feedamp_status_changed_beforedatetimeOptional

Feedamp order status was last changed before this datetime. RFC-3339 date-time format — fractional seconds not allowed

limitintegerOptional1-250Defaults to 100

The max number of orders in the response.

cursorstringOptional

Cursor for the next page of orders.

include_raw_databooleanOptionalDefaults to false

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

Response

List of orders

orderslist of objects

next_cursorstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error

Authentication

Headers

Query parameters

Response

Errors