Feedonomics Docs

{
  "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": {}
    }
  ],
  "fulfillments": [
    {
      "mp_line_number": "XX-111-FF-1111",
      "shipments": [
        {
          "quantity": 1,
          "carrier": "UPS",
          "tracking_number": "XXX-DDD-XXXX-DDDD",
          "shipped_date": {},
          "tracking_url": "https://www.example.com/?track=XXX-DDD-XXXX-DDDD"
        }
      ],
      "cancellations": [
        {
          "quantity": 1,
          "reason": "customer_cancelled"
        }
      ],
      "status": "PENDING",
      "pending": {
        "quantity": 1
      }
    }
  ],
  "acknowledged": true,
  "status": "IN_PROGRESS",
  "is_marketplace_fulfilled": true,
  "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": {},
  "marketplace_state": "PENDING",
  "fulfillment_type": "shipment",
  "errors": [
    {
      "code": "FEEDAMP_FIELD_INVALID_VALUE",
      "message": "Value SOMETHING not valid for state"
    }
  ]
}

Get a specific order from FeedAMP

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

Response

Get Orders

mp_order_numberstring1-128 characters

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

sales_channelstring

The specific channel within a marketplace in which orders are processed (typically corresponds to region)

customerobject

purchase_datedatetime

The datetime of the purchase date. ISO 8601 date-time YYYY-MM-DDTH:i:sZ (all times must be in UTC)

currencyenum

ISO 4217 Currency codes

shipping_addressobject

order_lineslist of objects

A collection of OrderLine objects. This property contains the individual order lines that the seller is to fulfill

fulfillmentslist of objects

List of Lines fulfilled or cancelled by the seller. The data in this field is not modifiable by the marketplace via calls to the create and update endpoints

acknowledgedboolean

Indicates if the order has been acknowledged by the seller. The data in this field is not modifiable by the marketplace via calls to the create and update endpoints

statusenum

The state of the order in FeedAMP

PENDING - The order has been placed into FeedAMP but is not yet released for shipment
ORDERED - The order is ready for shipment but has not yet been acknowledged by the seller
IN_PROGRESS - The order has been acknowledged and is in the process of being fulfilled
CANCELLED - The seller has cancelled the order completely
FULFILLED - The seller has either completely fulfilled the order, or partially fulfilled and cancelled the remaining quantities
COMPLETE - The order has been acknowledged by the marketplace as being complete by changing the marketplace_state to SHIPPED or CANCELLED

is_marketplace_fulfilledboolean

Whether the order is fulfilled by the marketplace, and no further action is required by the seller to fulfill

True - The order is fulfilled by the marketplace
False - The seller must fulfill the order

locationobjectOptional

Details about the location (e.g. store) associated with an order

delivery_notesstringOptional

The customer’s instructions to the delivery service regarding where/how to leave the package

earliest_ship_datedatetimeOptional

The earliest expected ship-by date. ISO 8601 date-time YYYY-MM-DDTH:i:sZ (all times must be in UTC)

latest_ship_datedatetimeOptional

The latest expected ship-by date. ISO 8601 date-time YYYY-MM-DDTH:i:sZ (all times must be in UTC)

latest_delivery_datedatetimeOptional

The latest expected deliver-by date. ISO 8601 date-time YYYY-MM-DDTH:i:sZ (all times must be in UTC)

earliest_delivery_datedatetimeOptional

The earliest expected deliver-by date. ISO 8601 date-time YYYY-MM-DDTH:i:sZ (all times must be in UTC)

gift_messagestringOptional

Gift message attached to order

marketing_opt_inbooleanOptional

Whether the customer opted in to marketing emails

billing_addressobjectOptional

order_additional_propertiesmap from strings to anyOptional

Key/Value pairs of data the marketplace wants to associate with an order

marketplace_stateenumOptional

The state of the order in the marketplace

PENDING - Order is still awaiting payment or other finalization before being eligible for fulfillment
AWAITING_SHIPMENT - The marketplace does not yet have any fulfillment information for the order
SHIPPED - The marketplace has successfully retrieved fulfillment information for the entire order
CANCELLED - The order has been cancelled, either due to action initiated by the marketplace (customer cancelled) or the entire order has been cancelled during fulfillment processing (seller cancelled)

Allowed values:

fulfillment_typeenumOptional

Type of fulfillment required for the order

shipment - Requires shipment by the seller
digital - No physical fulfillment
pickup - Order prepared for local pickup by buyer

Allowed values:

errorslist of objectsOptional

Errors associated with the order

Errors

401

Unauthorized Error