--- title: Orders slug: webservices-v1/orders createdAt: 2022-07-01T08:07:49.000Z --- ## GetOrders: Order Retrieval The getOrders method sends back all the orders matching the filter defined in your entry parameters. **\*Note: **\**The response is limited to the 200 most recent orders by result page (although in the response, the orders are not listed in chronological order), it can be necessary to go through several pages to retrieve the full amount of orders you want.* Orders retrieval is one of the most frequent requests. This method has no mandatory parameter. If no parameter is specified, all the orders are sent in response. It is nevertheless recommended that you define the date filters (date of sale or payment) proposed by this method in order to retrieve, for example, the orders that have been paid during a given period of time. The getOrders response is a list of order lines (an order can contain several order lines). The most important information is: - **OrderID** - **OrderLineID** - **ShippingAddress** Neteven IDs (order and order line) are very important because they are used to update information related to the orders (among others shipping confirmation). By default, DatePaument field is empty when the payment hasn’t been done. So, if you retrieve, for example, the paid orders of the last month each time you send a call to our webservices, and if you make a call every two weeks, only the paid orders would be returned. Furthermore, some marketplaces take a longer time than usual to return some orders as paid when the paid amount exceed a certain threshold. That’s why we recommend to the merchants, who, like in this example, retrieve commands of the last two weeks, to, every month, get the whole commands of the last month. By doing so, they will be able to get orders of large amount. Base yourself on the marketplaceId instead of the marketplaceName to recognize a marketplace. The reason is that the marketplaceName is likely to change over the time. That’s why we don’t enable the specification of the marketplaceName in PostOrder requests, but solely of the marketplaceId. Please note that some information (in particular address information) have restrictions linked to the marketplace. For example: - Pixmania: payment date not timestamped + title not given (Mr, Mrs, Ms…) - eBay: - Buyer’s first name and surname are concatenated in a unique field - eBay orders are returned as Not Paid until eBay confirms the sending of the payment by the buyer. In the case the order is paid in cash, the merchand is free to register it as Paid. - Priceminister: generic mail sent to all buyers ***‘1.4 additions part 3’ start here*** With regard to additional fields, the **ArrayOfAdditionalFields **parameter allows you to fetch this information for your orders. **Example :** :::BlockQuote \ \xyz\ \abc\ \ ::: With regard to additional fields, the ArrayOfAdditionalFields parameter allows you to fetch this information for your orders. - WarehouseId - WarehouseStock - WarehouseName ***‘1.4 additions part 3’ end here*** **Entry parameters** | **Field** | **Type/Size** | **Remarks** | | -------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | PageNumber | Integer | Result page number | | DateSaleFrom | DateTime | Marketplace selling date minimum | | DateSaleTo | DateTime | Marketplace selling date maximum | | DatePaymentFrom | DateTime | Marketplace payment date minimum | | DatePaymentTo | DateTime | Marketplace payment date maximum | | DateCreationFrom | DateTime | Neteven creation date minimum | | DateCreationTo | DateTime | Neteven creation date maximum | | DateModificationFrom | DateTime | Neteven modification date minimum | | DateModificationTo | DateTime | Neteven modification date maximum | | DateAvailabilityFrom | DateTime | Product availability date minimum | | DateAvailabilityTo | DateTime | Product availability date maximum | | MarketPlaceId | String | Marketplace ID (see annexe) | | OrderID | String | Neteven order ID | | MarketPlaceOrderId | String | Marketplace order ID | | OrderLineID | String | Neteven order line ID | | Status | String | ToConfirm : New order to manageConfirmed : Validated order (has to be shipped)Canceled : canceled orderRefunded : Refunded orderShipped : Shipped order | | WarehouseShippable | Boolean | ‘True’ = if the order can be shipped from a specific warehouse (corresponding to the WarehouseId) | | OrderLineAck | Boolean | ‘True’ = if the order is flagged as “being prepared”‘False’ = if not | **Results of the method: List of MarketPlaceOrder elements:** | **Field** | **Type/Size** | **Remarks** | | -------------------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ID | String | Neteven order line ID | | OrderID | String | Neteven order ID | | OrderLineID | Text | Neteven order line ID | | Status | OrderStatusEnum | ToConfirm : New order to manageConfirmed : Validated order (has to be shipped)Canceled : canceled orderRefunded : Refunded orderShipped : Shipped order | | CustomerId | String | Customer ID | | MarketPlaceOrderId | String | Marketplaceorder ID | | MarketPlaceOrderLineId | String | Marketplace order line ID | | MarketPlaceTransactionId | String | MarketPlace transaction ID | | MarketPlaceName | String | Marketplace name | | MarketPlaceListingId | String | MarketPlace listing ID | | MarketPlaceSaleId | String | MarketPlace sale ID | | MarketPlaceInvoiceId | String | Marketplace ID of the receipt | | SKU | String | Stock keeping unit | | DateSale | dateTime | Order sale date | | DatePayment | dateTime | Order payment date | | DateShipping | dateTime | Shipping date | | TrackingNumber | String | Parcel tracking number | | AmountPaid | Price | Total amount paid for this order line (including ecotax, shipping and insurance costs) | | PaymentMethod | PaymentMethodEnum | Payment method | | Quantity | Double | Quantity ordered in this order line | | Price | Price | Price of this order line including ecotax | | InsuranceId | String | Insurance ID | | InsuranceCost | Price | Insurance cost for this order line without ecotax | | ShippingCost | Price | Shipping cost for this order line without ecotax | | FinalShippingCost | Price | (Idem ShippingCost) without ecotax | | OrderShippingCost | Price | Shipping cost for this order (including Taxes) | | ShipperId | String | Shipper ID | | VAT | Price | VAT amount without ecotax | | TotalCostWithVAT | Price | (idem AmountPaid) including ecotax | | MarketplaceFee | Price | Marketplace fee (not transmitted by most marketplaces) | | ProcessingFee | Double | Processing fee | | WarehouseId | Double | Warehouse ID (warehouse responsible for shipping this specific order line) | | WarehouseShippable | Boolean | Possibility to ship the product from this specific warehouse | | BillingAddress | MarketPlaceAddress | Billing address | | ShippingAddress | MarketPlaceAddress | Shipping address | | ReturnTrackingNumber | String | Return number required by Zalando marketplace in the delivery document and when the merchant confirms the shipping the orderWhen its value is empty, this tag is not present in the reply of our webservices to a GetOrders request | | ReturnTrackingUrl | String | Field not required by Zalando as automatically filled on their sideWhen its value is empty, this tag is not present in the reply of our webservices to a GetOrders request | | ReturnTrackingInfo | String | Field not required by Zalando as automatically filled on their sideWhen its value is empty, this tag is not present in the reply of our webservices to a GetOrders request | | Comment | String | Internal field to Neteven and unique for each order, not sent to the marketplacesRetrieved from the marketplace Farfetch when an order is created from a listing tied to a reduction percentage set on Farfetch.So in this case to have the amount actually paid by the customer on an order line, you have to substract the amount of this reduction percentage from the order line amount sent without reduction by Farfetch to Neteven | | PromotionCode | String | Retrieved from the marketplace Farfetch when an order is created from a listing tied to a reduction percentage set on Farfetch.So in this case to know the amount actually paid by the customer on an order line, you have to substract the amount of this reduction percentage from the order line amount sent without reduction by Farfetch to Neteven | | MarketplaceCustomerId | String | Customer ID sent from the Zalando marketplace to Neteven, and that can be required on the delivery document | | MarketPlaceProductReference | String | Product reference given by the MKP with the order (typically, the SKU Zalando) | | MerchantOrderId | String | Merchant ID to identify the order in his system | | MerchantOrderLineId | String | Merchant ID to identify the order line in his system | | DocumentURL | String | URL of documents to order delivery, invoicing, etc. can be written by merchant or Marketplace (Sportamore / ECI / Farfetch / VP, etc.) | | OrderLineDocumentURL | String | URL of documents to the order line for delivery, invoicing, etc. can be written by merchant or Marketplace (Sportamore / ECI / Farfetch / VP, etc.) | | OrderLineAck | Boolean | ‘True’ = if the order is flagged as “being prepared”‘False’ = if not | | OrderLineTrackingNumber | String | Tracking Number for the order line | | OrderLineTrackingInfo | String | Carrier name for the order line | | OrderLineTrackingURL | String | Tracking URL for the order line | | \*\*ArrayOfAdditionalFields \*\* | \*\*ArrayOfAdditionalFields \*\* | List of additional fields (see WSDL) | **MarketPlaceAddress data type description** | **Field** | **Type/Size** | **Remarks** | | ------------- | ------------- | ------------------------------------ | | FirstName | String | First name | | LastName | String | Last name | | Pseudo | String | Nickname | | Address1 | String | Address 1 | | Address2 | String | Address 2 | | CityName | String | City name | | PostalCode | String | Postal Code | | CountryCode | String | Following the SO 3166-1 alpha-2 code | | Country | String | Country | | Phone | String | Phone (if given) | | Mobile | String | Mobile (if given) | | Fax | String | Fax (if given) | | Email | String | Email (if given) | | Company | String | Firm name | | StateProvince | String | Province/Area/Region name (if given) | **Extract from a PHP5 script: Execution of a getOrders request to display the SKU of the products ordered** ::Image[]{src="https://api.archbee.com/api/optimize/ghphd2IJMfAWqrLDyV5lf/twQRyESb1Ir0jJbX-qtDX_image.png" size="50" isUploading="false" showCaption="false"} ::Image[]{src="https://api.archbee.com/api/optimize/ghphd2IJMfAWqrLDyV5lf/tKQQfH9hJYcCc7MdFyexK_image.png" size="50" isUploading="false" showCaption="false"} ## PostOrders: Order Update The postOrders method allows the status of the different orders to be updated and additional information such as the tracking number or the shipping date to be sent. To cancel, validate or confirm the shipping of an order or order line, you just have to do a postOrder with the following information for each order or order line: - Neteven order ID or order line ID - The corresponding status - Possible further information. **Note that:** – if you use the order ID, then all the order lines included in the order will be updated. – if you use the order line ID, then : – On our test marketplace named “Sandbox”, all the lines of the order matching your order line ID will be updated – On all the other live marketplaces, only that order line will be updated – as our webservices always wait for a value when a tag is used in your request, they will reply with an error if you use a tag without value. – Only the status "Shipped" allows a PostOrders call to update those MarketPlaceOrder elements used for a shipping confirmation : DateShipping TrackingInfo TrackingNumber OrderLineTrackingURL – Sometimes the string value of a URL that you provide in one of the following MarketPlaceOrder elements, can contain at least one special meta-character for example like "&" that will trigger a response from our webservices with the error code "400 Bad Request" and blocks the processing of your Postorder : OrderLineTrackingURL ReturnTrackingUrl DocumentURL OrderLineDocumentURL This is because a special meta-character is interpreted as XML code by default. In this case to avoid the error response "400 Bad Request" and make sure your PostOrder request is processed successfully, we advise you to always encapsulate the string value of your URL with the `` tag which declares this value as a full string without code. So for example, your would have this data for the element OrderLineTrackingURL in your request : :::CodeblockTabs ```xml ``` ```none ``` ```curl ``` ::: *** For orders that have to be validated (for example, orders from PriceMinister which has become Rakuten), it is mandatory to do two distinct requests (a request to validate the order and a request to confirm the shipping). In the case of a shipping confirmation: - The call to this method automatically triggers an update on the concerned marketplaces. - If no shipping date is specified the date of your request will be considered as the shipping date. In the case of order refund: - It is possible to specify an amount to refund with the field “AmountToRefund” (without this field, the total amount will be refunded by including the shipping cost). **Entry parameters** | **Field** | **Type/Size** | **Remarks** | | --------------- | ----------------------- | ------------------------------ | | PostItemsResult | ArrayOfMarketPlaceOrder | MarketPlaceOrder elements list | **List of Information expected for a postOrder** | **Field** | **Type/Size** | **Remarks** | | ----------------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | OrderIDou OrderLineID | Integer | Neteven order ID or order line ID | | OrderLineID | Text | Neteven order line ID | | Status | OrderStatusEnum | ConfirmedCanceledRefundedShipped | | DateShipping | dateTime | Shipping date (in the event of a shipping confirmation) | | AmountToRefund | Double | Amount to refund | | TrackingNumber | String | Parcel tracking number (in the event of a shipping confirmation) | | TrackingInfo | String | Free field, can host the url of the package tracking service, or the name of the shipperThis field is not saved in Neteven for orders from the marketplaces Ebay and Backmarket as they are not required by them to confirm a shipping. | | MerchantOrderId | String | Merchant ID to identify the order in his system | | MerchantOrderLineId | String | Merchant ID to identify the order line in his system | | DocumentURL | String | URL of documents to order delivery, invoicing, etc. can be written by merchant or Marketplace (Sportamore / ECI / Farfetch / VP, etc.) | | OrderLineDocumentURL | String | URL of documents to the order line for delivery, invoicing, etc. can be written by merchant or Marketplace (Sportamore / ECI / Farfetch / VP, etc.) | | OrderLineAck | Boolean | ‘True’ \= flag the order as “being prepared”. Also, In order to partially update a multi-line order, you can send one (or more) order lines with their order line id(s) and this parameter as ‘True’. This operation will update only the order lines sent and not the entire order. OrderLineAck (=True) can also be used in combination with the OrderID to update the entire order. | | OrderLineTrackingNumber | String | Tracking Number for the order line | | OrderLineTrackingInfo | String | Carrier name for the order line | | OrderLineTrackingURL | String | Tracking URL for the order line | | DeliveryDocumentBase64 | String | PDF file encoded in base 64 | | CancelationReason | String | Cancellation reason for the orderline | | RefundReason | String | Refund reason for the orderline | | DateExpectedDelivery | dateTime | Expected delivery date of the order to the consumer | **Results** | **Field** | **Type/Size** | **Remarks** | | ---------------- | ------------------------------ | -------------------------------------------------------------------------------- | | PostOrdersResult | MarketPlaceOrderStatusResponse | Summary table for each updated order (Updated or Error)See WSDL for more details | **Extract of a PHP5 script: Execution of a postOrders request to validate, cancel and confirm expedition of 3 orders** ::Image[]{src="https://api.archbee.com/api/optimize/ghphd2IJMfAWqrLDyV5lf/587G4j4y69N_smRYcf1Mg_image.png" size="50" isUploading="false" showCaption="false"} ::Image[]{src="https://api.archbee.com/api/optimize/ghphd2IJMfAWqrLDyV5lf/QKK8uBNVygbCU6LsXJXUq_image.png" size="50" isUploading="false" showCaption="false"}