> This page is for Developer. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.feedonomics.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.feedonomics.com/_mcp/server. # Get Order GET https://marketplace-order-api.feedamp.feedonomics.com/api/v1/orders/{mp_order_number} Get a specific order from FeedAMP Reference: https://docs.feedonomics.com/developer/api-reference/rest/feed-amp-order-source-api/orders/get-order ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `mp_order_number` (string, required) — The unique Id for an order that is generated by the marketplace ## Response ### 200 Get Orders - `mp_order_number` (string, required) — The primary order number used to identify the order in the marketplace's system - `sales_channel` (string, required) — The specific channel within a marketplace in which orders are processed (typically corresponds to region) - `customer` (Customer, required) - `purchase_date` (datetime, required) — The datetime of the purchase date. ISO 8601 date-time YYYY-MM-DDTH:i:sZ (all times must be in UTC) - `currency` (enum, required) — ISO 4217 Currency codes - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `CNY`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SLL`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `UYI`, `UYU`, `UYW`, `UZS`, `VED`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XSU`, `XTS`, `XUA`, `XXX`, `YER`, `ZAR`, `ZMW`, `ZWL` - `shipping_address` (StreetAddress, required) - `order_lines` (list of OrderLine, required) — A collection of OrderLine objects. This property contains the individual order lines that the seller is to fulfill - `fulfillments` (list of OrderFulfillment, required) — 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 - `acknowledged` (boolean, required) — 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 - `status` (enum, required) — 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 - Allowed values: `PENDING`, `ORDERED`, `IN_PROGRESS`, `CANCELLED`, `FULFILLED`, `COMPLETE` - `is_marketplace_fulfilled` (boolean, required) — 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 - `location` (Location, optional) — Details about the location (e.g. store) associated with an order - `delivery_notes` (string, optional) — The customer's instructions to the delivery service regarding where/how to leave the package - `earliest_ship_date` (datetime, optional) — The earliest expected ship-by date. ISO 8601 date-time YYYY-MM-DDTH:i:sZ (all times must be in UTC) - `latest_ship_date` (datetime, optional) — The latest expected ship-by date. ISO 8601 date-time YYYY-MM-DDTH:i:sZ (all times must be in UTC) - `latest_delivery_date` (datetime, optional) — The latest expected deliver-by date. ISO 8601 date-time YYYY-MM-DDTH:i:sZ (all times must be in UTC) - `earliest_delivery_date` (datetime, optional) — The earliest expected deliver-by date. ISO 8601 date-time YYYY-MM-DDTH:i:sZ (all times must be in UTC) - `gift_message` (string, optional) — Gift message attached to order - `marketing_opt_in` (boolean, optional) — Whether the customer opted in to marketing emails - `billing_address` (StreetAddress, optional) - `order_additional_properties` (map from string to any, optional) — Key/Value pairs of data the marketplace wants to associate with an order - `marketplace_state` (enum, optional) — 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: `PENDING`, `AWAITING_SHIPMENT`, `SHIPPED`, `CANCELLED` - `fulfillment_type` (enum, optional) — 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: `shipment`, `digital`, `pickup` - `errors` (list of FeedAmpOrderModelErrorsItems, optional) — Errors associated with the order ## Errors ### 401 Unauthorized Error Invalid token - `error` (string, optional) — Message describing the authentication failure ## Types ### Customer - `full_name` (string, optional) — The full name of the customer - `email` (string, optional) — The customer's email address - `phone` (string, optional) — The phone number of the customer - `vat` (string, optional) — International Value-Added Tax identification number of customer ### StreetAddress - `full_name` (string, required) — Name of primary recipient - `address1` (string, required) — Street address, line 1 - `city` (string, required) — Address (City) - `state` (string, required) — Address (State or Province) - `postal_code` (string, required) — Address (Postal or Zip code) - `country_code` (enum, required) — ISO 3166-1 alpha-3 country codes - Allowed values: `ABW`, `AFG`, `AGO`, `AIA`, `ALA`, `ALB`, `AND`, `ARE`, `ARG`, `ARM`, `ASM`, `ATA`, `ATF`, `ATG`, `AUS`, `AUT`, `AZE`, `BDI`, `BEL`, `BEN`, `BES`, `BFA`, `BGD`, `BGR`, `BHR`, `BHS`, `BIH`, `BLM`, `BLR`, `BLZ`, `BMU`, `BOL`, `BRA`, `BRB`, `BRN`, `BTN`, `BVT`, `BWA`, `CAF`, `CAN`, `CCK`, `CHE`, `CHL`, `CHN`, `CIV`, `CMR`, `COD`, `COG`, `COK`, `COL`, `COM`, `CPV`, `CRI`, `CUB`, `CUW`, `CXR`, `CYM`, `CYP`, `CZE`, `DEU`, `DJI`, `DMA`, `DNK`, `DOM`, `DZA`, `ECU`, `EGY`, `ERI`, `ESH`, `ESP`, `EST`, `ETH`, `FIN`, `FJI`, `FLK`, `FRA`, `FRO`, `FSM`, `GAB`, `GBR`, `GEO`, `GGY`, `GHA`, `GIB`, `GIN`, `GLP`, `GMB`, `GNB`, `GNQ`, `GRC`, `GRD`, `GRL`, `GTM`, `GUF`, `GUM`, `GUY`, `HKG`, `HMD`, `HND`, `HRV`, `HTI`, `HUN`, `IDN`, `IMN`, `IND`, `IOT`, `IRL`, `IRN`, `IRQ`, `ISL`, `ISR`, `ITA`, `JAM`, `JEY`, `JOR`, `JPN`, `KAZ`, `KEN`, `KGZ`, `KHM`, `KIR`, `KNA`, `KOR`, `KWT`, `LAO`, `LBN`, `LBR`, `LBY`, `LCA`, `LIE`, `LKA`, `LSO`, `LTU`, `LUX`, `LVA`, `MAC`, `MAF`, `MAR`, `MCO`, `MDA`, `MDG`, `MDV`, `MEX`, `MHL`, `MKD`, `MLI`, `MLT`, `MMR`, `MNE`, `MNG`, `MNP`, `MOZ`, `MRT`, `MSR`, `MTQ`, `MUS`, `MWI`, `MYS`, `MYT`, `NAM`, `NCL`, `NER`, `NFK`, `NGA`, `NIC`, `NIU`, `NLD`, `NOR`, `NPL`, `NRU`, `NZL`, `OMN`, `PAK`, `PAN`, `PCN`, `PER`, `PHL`, `PLW`, `PNG`, `POL`, `PRI`, `PRK`, `PRT`, `PRY`, `PSE`, `PYF`, `QAT`, `REU`, `ROU`, `RUS`, `RWA`, `SAU`, `SDN`, `SEN`, `SGP`, `SGS`, `SHN`, `SJM`, `SLB`, `SLE`, `SLV`, `SMR`, `SOM`, `SPM`, `SRB`, `SSD`, `STP`, `SUR`, `SVK`, `SVN`, `SWE`, `SWZ`, `SXM`, `SYC`, `SYR`, `TCA`, `TCD`, `TGO`, `THA`, `TJK`, `TKL`, `TKM`, `TLS`, `TON`, `TTO`, `TUN`, `TUR`, `TUV`, `TWN`, `TZA`, `UGA`, `UKR`, `UMI`, `URY`, `USA`, `UZB`, `VAT`, `VCT`, `VEN`, `VGB`, `VIR`, `VNM`, `VUT`, `WLF`, `WSM`, `YEM`, `ZAF`, `ZMB`, `ZWE` - `address_type` (string, optional) — What kind of establishment is located at this address? - `address2` (string, optional) — Street address, line 2 - `address3` (string, optional) — Street address, line 3 (international shipping address info) - `phone` (string, optional) — Phone number associated with address ### OrderLine An object representing a line in an order - `mp_line_number` (string, required) — The marketplace identifier of this unique order line - `sku` (string, required) — The SKU of the marketplace product represented by this order line - `product_name` (string, required) — The product title, as displayed in the marketplace listing - `quantity` (integer, required) — The amount of product ordered - `unit_price` (double, required) — The price for a single (1) quantity of product (not including tax, shipping, or discounts) - `shipping_method` (string, optional) — The shipping method the seller is required to use to fulfill this order line - `shipping_price` (double, optional) — The total shipping price for this order line - `taxes` (list of Tax, optional) — A collection of taxes that are levied against the order line - `discounts` (list of Discount, optional) — A collection of discounts that are applied to the order line - `is_tax_collected_by_marketplace` (boolean, optional) — Indicates whether taxes are collected by the marketplace - `order_line_additional_properties` (map from string to any, optional) — Key/Value pairs of data the marketplace wants to associate with an order line ### OrderFulfillment All the shipments and cancellations for an order line - `mp_line_number` (string, required) — The order line identifier provided by the marketplace. - `shipments` (list of Shipment, required) - `cancellations` (list of Cancellation, required) - `status` (enum, required) — The status of the fulfillments PENDING - No fulfillment information is available for the order PARTIALLY\_FULFILLED - Order has been partially fulfilled/cancelled. One or more items are unaccounted for COMPLETE - The order has been completely fulfilled - Allowed values: `PENDING`, `PARTIALLY_FULFILLED`, `COMPLETE` - `pending` (OrderFulfillmentPending, optional) ### Location Details about the location (e.g. store) associated with an order - `source_location_id` (string, optional) — The location identifier assigned by the source platform - `client_location_id` (string, optional) — The location identifier assigned by the client platform - `name` (string, optional) — The assigned name for the location - `address` (string, optional) — The address of the location ### FeedAmpOrderModelErrorsItems - MarketplaceError: MarketplaceError - FeedAMPError: FeedAMPError ### Tax An object representing a tax applied to an order line - `type` (enum, required) — The type of tax - Allowed values: `SHIPPING`, `SALES`, `GST`, `PST`, `VAT` - `amount` (double, required) — The tax amount ### Discount An object representing a discount applied to an order line - `name` (string, required) — The discount identifier, as configured in the marketplace - `amount` (double, required) — The order line total discount amount - `type` (enum, required) — The type of discount ITEM - Discount applies to item price SHIPPING - Discount applies to shipping price - Allowed values: `ITEM`, `SHIPPING` ### Shipment Object representing a shipment of 1 or more items for an order line - `quantity` (integer, required) — The quantity in the shipment - `carrier` (enum, required) — Carrier used by seller for shipping. Must be a valid carrier name - Allowed values: `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, required) - `shipped_date` (date, optional) — Date the item was shipped. ISO 8601 DATE YYYY-MM-DD - `tracking_url` (string, optional) ### Cancellation Object representing the cancellation of 1 or more items of an order line - `quantity` (integer, required) — The quantity being cancelled - `reason` (enum, required) — Reason provided for the order line's cancellation - Allowed values: `customer_cancelled`, `unable_to_ship`, `out_of_stock`, `price_error`, `tax_error`, `shipping_price_error`, `other` ### OrderFulfillmentPending - `quantity` (integer, required) — Number of items unaccounted for ### MarketplaceError Validation errors reported by the marketplace - `code` (enum, required) — Code to uniquely identify the type of error - Allowed values: `EXCESS_FULFILLMENT`, `EXCESS_CANCELLATION`, `INVALID_TRACKING_NUMBER`, `INVALID_TRACKING_URL`, `INVALID_CARRIER`, `INVALID_SHIPPING_DATE`, `INVALID_CANCEL_REASON`, `ORDER_FULFILLED`, `ORDER_CANCELLED`, `ORDER_REFUNDED` - `message` (string, required) — The error message for the error code - `mp_line_number` (string, optional) — Order line number that has an error - `debug` (list of map from string to any, optional) ### FeedAMPError Validation error detected when placing/updating an order - `code` (enum, required) — Code to uniquely identify the type of error - Allowed values: `FEEDAMP_FIELD_INCORRECT_DATA_TYPE`, `FEEDAMP_FIELD_INVALID_VALUE`, `FEEDAMP_MISSING_REQUIRED_FIELD`, `FEEDAMP_UNKNOWN_FIELD_PRESENT` - `message` (string, required) — The error message for the error code ## Examples **Response** ```json { "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" } ] } ``` **SDK Code** ```python import requests url = "https://marketplace-order-api.feedamp.feedonomics.com/api/v1/orders/mp_order_number" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://marketplace-order-api.feedamp.feedonomics.com/api/v1/orders/mp_order_number'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://marketplace-order-api.feedamp.feedonomics.com/api/v1/orders/mp_order_number" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://marketplace-order-api.feedamp.feedonomics.com/api/v1/orders/mp_order_number") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://marketplace-order-api.feedamp.feedonomics.com/api/v1/orders/mp_order_number") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://marketplace-order-api.feedamp.feedonomics.com/api/v1/orders/mp_order_number', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://marketplace-order-api.feedamp.feedonomics.com/api/v1/orders/mp_order_number"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://marketplace-order-api.feedamp.feedonomics.com/api/v1/orders/mp_order_number")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```