BEbeezup
Marketplaces - Orders V3 - List

Get a paginated list of all Orders with all Order and Order Item(s) properties

Changed on

The purpose of this operation is to reduce the amount of request to the API.

Previous implmentation of this feature only returned a partial (light) version of the Orders. The purpose of this API is to reduce the number of incoming requests by returning the complete (full) Order and Order Item(s) properties.

post/orders/v3//list/full

Request

Headers

Accept-Encodingstring required

Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size

Request body

marketplaceTechnicalCodesBeezUPCommonMarketplaceTechnicalCode[]
marketplaceBusinessCodesBeezUPCommonMarketplaceBusinessCode[]
accountIdsAccountId[]

Account Id list

storeIdsBeezUPCommonStoreId[]

Store Id list

beezUPOrderStatusesBeezUPOrderStatus[]
dateSearchType'Modification' | 'Purchase' | 'MarketPlaceModification'

Indicates on which date you want to make the filter

beginPeriodUtcDatestring date-time required

The begin period you want to make the search.
The period MUST not be greater than 62 days. The begin period MUST be lower than the end period.

endPeriodUtcDatestring date-time required

The end period of you search.
The period MUST not be greater than 62 days.
The end period MUST be greater than the begin period. The end period MUST be lower to the current date.

invoiceAvailabilityTypestring

Indicates on which invoice availability to filter

order_Buyer_Namestring

Buyer full name

marketplaceOrderIdsMarketplaceOrderId[]
orderMerchantInfoSynchronizationStatusstring

Indicates on which order merchant info synchronization status to filter

order_MerchantOrderIdsOrderMerchantOrderId[]

Merchant order id list

pageSizeinteger required

Indicate the item count per page

pageNumberinteger required

Indicates the page number

Example request

{
  "marketplaceTechnicalCodes": [
    "PriceMinister"
  ],
  "marketplaceBusinessCodes": [
    "PRICEMINISTER"
  ],
  "accountIds": [
    "12345"
  ],
  "storeIds": [
    "64f43358-63a1-47f7-97ec-0301fc39956b"
  ],
  "beezUPOrderStatuses": [
    "InProgress"
  ],
  "beginPeriodUtcDate": "2017-03-01T13:10:01Z",
  "endPeriodUtcDate": "2017-04-01T13:10:01Z",
  "invoiceAvailabilityType": "All",
  "order_Buyer_Name": "Monroe",
  "marketplaceOrderIds": [
    "AmazonOrderId1234"
  ],
  "orderMerchantInfoSynchronizationStatus": "All",
  "order_MerchantOrderIds": [
    "MyOrderId1234"
  ]
}

Response

Successfully fetched the full list of Orders

Example response

{
  "orders": [
    {
      "marketplaceTechnicalCode": "Amazon",
      "beezUPOrderId": "00000000000000000000000000000000000000000000000",
      "beezUPOrderUrl": "http://www.mydomain.com",
      "marketplaceBusinessCode": "GOSPORT",
      "order_MarketplaceOrderId": "AMAZON12345",
      "order_Status_BeezUPOrderStatus": "Shipped",
      "order_Status_MarketplaceOrderStatus": "In_progress_3",
      "order_MerchantOrderId": "MyOrderMerchantId",
      "order_MerchantECommerceSoftwareName": "Prestashop",
      "order_MerchantECommerceSoftwareVersion": "123.0.1",
      "order_PurchaseUtcDate": "2017-03-31T21:30:23Z",
      "order_LastModificationUtcDate": "2017-04-16T10:30:23Z",
      "order_MarketplaceLastModificationUtcDate": "2017-04-16T10:25:23Z",
      "order_Buyer_Name": "Monroe",
      "order_CurrencyCode": "EUR",
      "etag": "\"ca071a4580129f932a03971968ffef69\"",
      "order_MarketPlaceChannel": "Amazon France",
      "order_PaymentMethod": "1 / 1X",
      "order_PayingUtcDate": "2017-04-01T13:22:01Z",
      "order_Comment": "This is a comment",
      "order_Shipping_FirstName": "Monroe",
      "order_Shipping_LastName": "Monroe",
      "order_Shipping_Civility": "MRS",
      "order_Shipping_CompanyName": "My Company",
      "order_Shipping_AddressName": "Jacques BAUREGARD",
      "order_Shipping_Email": "client_000000@manomano.fr",
      "order_Shipping_AddressLine1": "5 rue amélie",
      "order_Shipping_AddressLine2": "BDR",
      "order_Shipping_AddressLine3": "RDC",
      "order_Shipping_AddressPostalCode": "13014",
      "order_Shipping_AddressCity": "Marseille",
      "order_Shipping_AddressStateOrRegion": "BDR",
      "order_Shipping_AddressCountryName": "France",
      "order_Shipping_AddressCountryIsoCodeAlpha2": "FR",
      "order_Shipping_Phone": "+33000000041",
      "order_Shipping_MobilePhone": "+33000000042",
      "order_Shipping_Method": "DPD Domicile",
      "order_Shipping_EarliestShipUtcDate": "2017-04-02T21:30:00Z",
      "order_Shipping_LatestShipUtcDate": "2017-04-30T21:30:00Z",
      "order_Buyer_Identifier": "1234567890",
      "order_Buyer_FirstName": "Monroe",
      "order_Buyer_LastName": "Monroe",
      "order_Buyer_Civility": "Marseille",
      "order_Buyer_CompanyName": "Marsillia",
      "order_Buyer_Email": "client_000000@manomano.fr",
      "order_Buyer_AddressLine1": "5 rue amélie",
      "order_Buyer_AddressLine2": "BDR",
      "order_Buyer_AddressLine3": "RDC",
      "order_Buyer_AddressPostalCode": "13014",
      "order_Buyer_AddressCity": "Marseille",
      "order_Buyer_AddressStateOrRegion": "BDR",
      "order_Buyer_AddressCountryName": "France",
      "order_Buyer_AddressCountryIsoCodeAlpha2": "FR",
      "order_Buyer_Phone": "+33000000101",
      "order_Buyer_MobilePhone": "+33000000042",
      "order_Buyer_CompanyVATNumber": "FR12345678901",
      "order_OrderSourceUri": "http://beezupblob.com/order.xml",
      "order_OrderItemsSourceUri": "http://beezupblob.com/orderItems.xml",
      "orderItems": [
        {
          "beezUPOrderItemId": "1",
          "orderItem_Id": "A13V1IB3VIYZZH",
          "orderItem_OrderItemType": "Product",
          "orderItem_MerchantImportedProductId": "73267",
          "orderItem_MerchantImportedProductIdColumnName": "reference",
          "orderItem_MerchantImportedProductUrl": "http://blabla.com/my-folder/73267.html",
          "orderItem_MerchantProductIdColumnName": "reference_produit",
          "orderItem_BeezUPStoreId": "00000000-cceb-4c20-b2c9-000000000000",
          "orderItem_Title": "bLA acide-plomb 6v-4.5ah 70x48x106mm",
          "orderItem_ImageUrl": "http://blabla.com//das6-45.jpg",
          "orderItem_MerchantProductId": "BlaLdas6-4.5",
          "orderItem_gtin": "gtin_sample",
          "orderItem_Condition": "New",
          "orderItem_MarketplaceProductUri": "http://beezupblob.com/productLink.xml",
          "orderItem_MarketplaceImageUri": "http://beezupblob.com/marketplaceImg.jpg",
          "orderItem_GiftWrapLevel": "Papier cadeau"
        }
      ],
      "links": {
        "self": {
          "href": "/orders/v3/Amazon/1001/00000000000000000000000000000000000000000000000",
          "method": "GET"
        },
        "history": {
          "href": "/orders/v3/Amazon/1001/00000000000000000000000000000000000000000000000/history",
          "method": "GET"
        },
        "harvest": {
          "href": "/orders/v3/Amazon/1001#/00000000000000000000000000000000000000000000000/harvest",
          "method": "POST"
        },
        "setMerchantInfo": {
          "href": "/orders/v3/Amazon/1001/00000000000000000000000000000000000000000000000/setMerchantOrderInfo",
          "method": "POST",
          "parameters": {
            "request": {
              "in": "body",
              "type": "object",
              "schema": "setMerchantOrderInfoRequest"
            }
          }
        },
        "clearMerchantInfo": {
          "href": "/orders/v3/Amazon/1001/00000000000000000000000000000000000000000000000/clearMerchantOrderInfo",
          "method": "POST"
        }
      },
      "transitionLinks": [
        {
          "rel": "ShipOrder",
          "href": "/orders/v3/Amazon/1001/00000000000000000000000000000000000000000000000/ShipOrder",
          "method": "POST",
          "templated": "true",
          "parameters": {
            "If-Match": {
              "in": "header",
              "value": "\"ca071a4580129f932a03971968ffef69\"",
              "required": true,
              "type": "string"
            },
            "testMode": {
              "in": "query",
              "type": "boolean",
              "required": false,
              "value": "false"
            },
            "userName": {
              "in": "query",
              "type": "string",
              "required": true
            },
            "request": {
              "in": "body",
              "type": "object",
              "schema": "changeOrderRequest",
              "properties": {
                "order_Shipping_FulfillmentDate": {
                  "required": true,
                  "type": "date-time"
                },
                "order_Shipping_ShipperTrackingNumber": {
                  "required": true,
                  "type": "string"
                },
                "order_Shipping_CarrierName": {
                  "required": true,
                  "type": "string",
                  "lovRequired": "true",
                  "lovLink": {
                    "href": "/v2/user/PriceMinisterCarrierName"
                  }
                },
                "order_Shipping_Method": {
                  "required": true,
                  "type": "string",
                  "lovRequired": "false",
                  "lovLink": {
                    "href": "/v2/user/ShippingMethod_PriceMinister"
                  }
                }
              }
            }
          }
        },
        {
          "rel": "CancelOrder",
          "href": "/orders/v3/Amazon/1001/00000000000000000000000000000000000000000000000/CancelOrder",
          "method": "POST",
          "templated": "true",
          "parameters": {
            "If-Match": {
              "in": "header",
              "value": "\"ca071a4580129f932a03971968ffef69\"",
              "required": true,
              "type": "string"
            },
            "testMode": {
              "in": "query",
              "type": "boolean",
              "required": false,
              "value": "false"
            },
            "userName": {
              "in": "query",
              "type": "string",
              "required": true
            },
            "request": {
              "in": "body",
              "type": "object",
              "schema": "changeOrderRequest",
              "properties": {
                "order_Cancel_Reason": {
                  "required": true,
                  "type": "string"
                }
              }
            }
          }
        }
      ]
    }
  ],
  "links": {
    "harvest": {
      "href": "/orders/v3/harvest",
      "method": "POST"
    },
    "setMerchantInfos": {
      "href": "/orders/v3/setMerchantOrderInfos",
      "method": "POST",
      "parameters": {
        "request": {
          "in": "body",
          "required": true,
          "type": "object",
          "schema": "setMerchantOrderInfoRequest"
        }
      }
    },
    "clearMerchantInfos": {
      "href": "/orders/v3/clearMerchantOrderInfos",
      "method": "POST"
    },
    "status": {
      "href": "/orders/v3/status",
      "method": "GET"
    },
    "self": {
      "href": "/orders/v3/list/full",
      "method": "POST",
      "properties": {
        "Accept-Encoding": {
          "in": "header",
          "required": true,
          "type": "string"
        },
        "request": {
          "in": "body",
          "required": false,
          "type": "object",
          "schema": "orderListRequest"
        }
      }
    }
  },
  "paginationResult": {
    "entryCount": "25",
    "pageCount": "38",
    "totalEntryCount": "943",
    "links": {
      "first": {
        "href": "/merchant/orders/v1/list/full",
        "method": "POST",
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "type": "object",
            "schema": "orderListRequest",
            "value": {
              "beginPeriodUtcDate": "2014-08-25T07:32:31.584Z",
              "endPeriodUtcDate": "2014-09-24T07:32:31.584Z",
              "pageSize": "25",
              "pageNumber": "1"
            }
          }
        ]
      },
      "last": {
        "href": "/merchant/orders/v1/list/full",
        "method": "POST",
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "type": "object",
            "schema": "orderListRequest",
            "value": {
              "beginPeriodUtcDate": "2014-08-25T07:32:31.584Z",
              "endPeriodUtcDate": "2014-09-24T07:32:31.584Z",
              "pageSize": "25",
              "pageNumber": "38"
            }
          }
        ]
      },
      "next": {
        "href": "/merchant/orders/v1/list/full",
        "method": "POST",
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "type": "object",
            "schema": "orderListRequest",
            "value": {
              "beginPeriodUtcDate": "2014-08-25T07:32:31.584Z",
              "endPeriodUtcDate": "2014-09-24T07:32:31.584Z",
              "pageSize": "25",
              "pageNumber": "2"
            }
          }
        ]
      }
    }
  }
}

Changes