RESTFeedAMP Order V2Orders

Get order by {order-id}

A single order model

Authentication

AuthorizationBasic

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

Path parameters

order-idlongRequired
The id of the order

Headers

tokenstringRequired

The Authentication token obtained from the v1 get_token route

clientintegerRequired
The ID of the client making the request

Query parameters

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

Response

Single order
idstring
Unique identifier for a record
marketplace_order_numberstring1-128 characters
The primary order number used to identify the order in the marketplace's system
customerobject
imported_datedatetime

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

purchase_datedatetime

The datetime of the purchase date. RFC-3339 format 2020-12-31T12:34:56-05:00

currencyenum
ISO 4217 Currency codes
shipping_addressobject
Customer's Shipping Information
order_lineslist of objects
A collection of OrderLine objects. This property contains the individual order lines that the seller is to fulfill
marketplace_statestring
The marketplace's own representation of the order state
customer_order_numberstring>=1 character

Customer-facing order number provided by marketplace

merchant_order_numberstring>=1 character

Order identifier in the merchant’s e-commerce platform

marketplace_namestring
The platform from which the order originated
integration_namestring

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

sales_channelstring

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

locationobject

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

delivery_notesstring

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

earliest_ship_datedatetime

The earliest expected ship-by date. RFC-3339 format 2020-12-31T12:34:56-05:00

latest_ship_datedatetime

The latest expected ship-by date.RFC-3339 format 2020-12-31T12:34:56-05:00

latest_delivery_datedatetime

The latest expected deliver-by date. RFC-3339 format 2020-12-31T12:34:56-05:00

earliest_delivery_datedatetime

The earliest expected deliver-by date. RFC-3339 format 2020-12-31T12:34:56-05:00

gift_messagestring
Gift message attached to order
marketing_opt_inboolean
Whether the customer opted in to marketing emails
billing_addressobject
Customer's Shipping Information
order_additional_propertiesmap from strings to any
Arbitrary data the marketplace associated with an order
payment_gateway_transactionslist of objects
A collection of PaymentGatewayTransaction objects
workflow_statusstring
FeedAMP’s internal representation of the orders’s progress through client-specific workflow. Common values: <ul>
  • IMPORTED - FeedAMP has imported the order from the sales channel, but it has not been forwarded to the merchant’s store platform
  • ON_HOLD - Order was created on the storefront, but is in a configured hold or remorse period before being released for shipment
  • SENT_FOR_FULFILLMENT - Merchant’s fulfillment platform has received the order and fulfillment is in progress
  • FULFILLED - Merchant has shipped everything in the order and FeedAMP has received the shipment information
  • CANCELLED - Order was cancelled, either by the sales channel (customer cancelled) or the merchant platform (e.g. item not available)
    • </ul>
    normalized_marketplace_stateenum
    FeedAMP’s interpretation of the marketplace state <ul>
  • PENDING - Order has been created on the sales channel, but is awaiting some outside process such as a fraud check or payment capture before it is ready for fulfillment.
  • AWAITING_ACKNOWLEDGEMENT - Order is from a sales channel that requires explicit acknowledgement, and the order has not yet been acknowledged.
  • AWAITING_SHIPMENT - Order is ready for fulfillment, and still has one or more items unshipped.
  • SHIPPED - The sales channel has successfully received fulfillment information for the entire order.
  • CANCELLED - The order has been cancelled, either due to action initiated by the sales channel (customer cancelled) or the entire order has been cancelled during fulfillment processing (seller cancelled).
  • MISSING - The order was imported to FeedAMP, but we have not yet determined the order’s status according to the sales channel.
  • UNRECOGNIZED - The sales channel reported a status value that FeedAMP does not understand.
    • </ul>
    is_marketplace_fulfilledbooleanDefaults to false
    Whether the order is fulfilled by the marketplace, and no further action is required by the seller to fulfill <ul>
  • True - The order is fulfilled by the marketplace
  • False - The seller must fulfill the order
    • </ul>
    marketplace_state_changed_atdatetime

    The time at which our system received the latest marketplace state change for the order. RFC-3339 format 2020-12-31T12:34:56-05:00

    fulfillment_typeenum
    Type of fulfillment required for the order <ul>
  • shipment - Requires shipment by the seller
  • digital - No physical fulfillment
  • pickup - Order prepared for local pickup by buyer
  • local_delivery - Order is fulfilled by a local store
    • </ul>
    Allowed values:
    shipment_service_levelstring
    Shipment Service Level
    shipment_nodestring
    Shipment Node

    Errors

    401
    Unauthorized Error
    404
    Not Found Error
    500
    Internal Server Error
    503
    Service Unavailable Error