BEbeezup
Marketplaces - Orders V3 - Order

Get full Order and Order Item(s) properties

Changed on
get/orders/v3//{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}

Request

Path parameters

marketplaceTechnicalCodestring BeezUPMarketplaceTechnicalCode required

The marketplace technical code

accountIdinteger required
beezUPOrderIdstring BeezUPOrderId required

The BeezUP Order identifier

Headers

If-None-Matchstring

ETag value to identify the last known version of requested resource.
To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.
If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.
For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

Response

Successfully fetched Order and Order Item(s) properties

marketplaceTechnicalCodestring required

The technical code of the marketplace.

accountIdinteger required

The marketplace account identifier in BeezUP. This account identifier is based on your api settings.

beezUPOrderIdstring required

The BeezUP Order identifier

beezUPOrderUrlstring

The URL <a href="https://en.wikipedia.org/wiki/URL">https://en.wikipedia.org/wiki/URL</a>

marketplaceBusinessCodestring required

In an marketplace technical code like CDiscount you can have several marketplaces like GO SPORT, etc. We identify them by a business code.

order_MarketplaceOrderIdstring required

The order marketplace identifier

order_Status_BeezUPOrderStatusstring required

BeezUP order status. Unified for all marketplaces.

order_Status_MarketplaceOrderStatusstring

The marketplace order state

order_MerchantOrderIdstring

The order merchant identifier

order_MerchantECommerceSoftwareNamestring

The e-commerce software name of the merchant

order_MerchantECommerceSoftwareVersionstring

The e-commece software version of the merchant

order_PurchaseUtcDatestring date-time required

The purchase date of this order

order_LastModificationUtcDatestring date-time required

The last modification UTC date done by BeezUP of this order

order_MarketplaceLastModificationUtcDatestring date-time required

The last modification UTC date done by the marketplace on this order

order_Buyer_Namestring

Buyer full name

order_TotalPricenumber

The total price of this order (corresponding to the amount paid by the customer)

order_CurrencyCodestring

The currency code <a href="https://en.wikipedia.org/wiki/ISO_4217">(ISO 4217)</a>

order_Invoice_Numberstring

The order invoice number

order_Invoice_Uristring

The order invoice URI

processingboolean required

If true, there is currently a harvest or an order change in progress. Otherwise false.

etagstring required

ETag value to identify the entity.
This information is required for the operation Get and Change.
For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

orderHarvestErrorsOrderHarvestErrors

The key is the OrderMetaInfo.

order_MarketPlaceChannelstring

Useful to identify the origin of the order. For example in Amazon.

order_TotalTaxnumber

The total tax of this order

order_TotalCommissionnumber

The total commission of this order

order_PaymentMethodstring

The payment method of this order

order_PayingUtcDatestring date-time

The UTC date of the payment of this order

order_Commentstring

The comment associated to this order

order_RelayIdstring

The id of the shipping relay handling the order

order_StatusReasonCodestring

The order cancellation cause

order_Shipping_FirstNamestring

Order Shipping first name

order_Shipping_LastNamestring

Order Shipping last name

order_Shipping_Civilitystring

The civility of the person in the shipping address for this order

order_Shipping_CompanyNamestring

The company name of the shipping address for this order

order_Shipping_AddressNamestring

The name of the person in the shipping address for this order

order_Shipping_Emailstring

The email of the person in the shipping address for this order

order_Shipping_AddressLine1string

The shipping address line 1 of this order

order_Shipping_AddressLine2string

The shipping address line 2 of this order

order_Shipping_AddressLine3string

The shipping address line 3 of this order

order_Shipping_AddressPostalCodestring

The shipping address postal code of this order

order_Shipping_AddressCitystring

The shipping address city of this order

order_Shipping_AddressStateOrRegionstring

The shipping address state or region of this order

order_Shipping_AddressCountryNamestring

The shipping address country name

order_Shipping_AddressCountryIsoCodeAlpha2string

The shipping address country iso code alpha 2 (see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#/decoding_table for more details)

order_Shipping_Phonestring

The phone number of the person in the shipping address for this order

order_Shipping_MobilePhonestring

The mobile phone number of the person in the shipping address for this order

order_Shipping_Pricenumber

The shipping price of this order

order_Shipping_Methodstring

The shipping method of this order

order_Shipping_ShippingTaxnumber

The shipping tax for this order

order_Shipping_EarliestShipUtcDatestring date-time

The UTC date of the earliest ship for this order

order_Shipping_LatestShipUtcDatestring date-time

The UTC date of the latest ship for this order

order_Buyer_Identifierstring

The buyer identifier for this order

order_Buyer_FirstNamestring

Order Buyer first name

order_Buyer_LastNamestring

Order Buyer last name

order_Buyer_Civilitystring

The buyer civility for this order

order_Buyer_CompanyNamestring

The buyer company name for this order

order_Buyer_Emailstring

The email of the buyer for this order

order_Buyer_AddressLine1string

The Buyer address line 1 of this order

order_Buyer_AddressLine2string

The Buyer address line 2 of this order

order_Buyer_AddressLine3string

The Buyer address line 3 of this order

order_Buyer_AddressPostalCodestring

The Buyer address postal code of this order

order_Buyer_AddressCitystring

The Buyer address city of this order

order_Buyer_AddressStateOrRegionstring

The Buyer address state or region of this order

order_Buyer_AddressCountryNamestring

The Buyer address country name

order_Buyer_AddressCountryIsoCodeAlpha2string

The Buyer address country iso code alpha 2 (see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#/decoding_table for more details)

order_Buyer_Phonestring

The phone number of the buyer for this order

order_Buyer_MobilePhonestring

The mobile phone number of the buyer for this order

order_IsPrimeboolean

Indicates if the order is considered as Prime (only on Amazon)

order_FulfilledBystring

The order FulfilledBy

order_IsBusinessboolean

The order IsBusiness

order_ChannelOrderIdstring

The order channel id (octopia)

order_AdditionalOrderIdstring

An additional order reference for the customer

order_SellerContractIdstring

The seller's contract id.

order_Shipping_Deadlinestring

The order shipping deadline.

order_Total_Discountnumber

The order total discount.

order_Total_AdditionalFeesnumber

The order total additional fees.

order_EarliestDeliveryDatestring date-time

The order earliest delivery date.

order_LatestDeliveryDatestring date-time

The order latest delivery date.

order_TotalPrice_ExclVatnumber

The order total price excluding VAT.

order_HasIncidentboolean

Indicates if the order has an incident

order_PaymentMethodDetailsstring

The payment method details of the order

order_Shipping_ShipmentServiceLevelCategorystring

The shipping service level category of the order

order_Shipping_RefundAmountstring

The shipping refund amount of the order

order_PurchaseOrderNumberstring

The purchase order number

order_Shipping_Labelstring

The order shipping label

order_IsAmazonInvoicedstring

Determines if the order has been invoiced by Amazon

order_Carriersstring

Carriers list of the order (when the marketplace combines delivery mode chosen by the buyer and the carriers)

order_Buyer_CompanyVATNumberstring

The Buyer company VAT number

order_PromotionDiscount_Amountstring

The order promotion discount amount

order_OrderSourceUristring uri

The url to the source of this order. We received this information from the marketplace.

order_OrderItemsSourceUristring uri

The url to the source of this order items. We received this information from the marketplace.

Example response

{
  "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"
            }
          }
        }
      }
    }
  ]
}

Changes