GET v1​/ sell​/shop​/orders

Returns a collection of orders received by the shop

Instant gratification

Do it yourself from console! Assuming that you have a valid token previously exported into BEARER env variable

Try to fetch the first page of your orders
curl -i -H "Authorization: Bearer $BEARER" \
https://api.blomming.com/v1/sell/shop/orders

Request

Example Request

{
  "currency": "EUR",
  "locale": "es",
  "order_status": "archived",
  "page": 2
}

Request Parameters

  • currency

    The currency in which the prices are exposed

    • Required: no
    • Type: string
    • Example: "EUR"
  • locale

    The locale used in the results

    • Required: no
    • Type: string
    • Example: "es"
  • order_status

    To filter the resultset by showing only orders in a certain state.

    If this param is not given, only Order in an open state (those orders whose state is equal to one of the following: to_pay_not_shipped, to_pay_shipped, to_ship_paid, to_ship_not_paid) will be returned.

    The above list of valid values for this parameter is served by the dictionary endpoint /sell/shop/orders/states.
    • Required: no
    • Type: string
    • Example: "archived"
    • oneOf: ["waiting_payment", "to_be_shipped", "closed", "archived", "cancel_requested", "cancelled"]
  • page

    The N page of the results

    • Required: no
    • Type: integer
    • Example: 2

Response

Example Response

[
  {
    "order_id": 79,
    "num_products": 1,
    "price": "23.50",
    "currency_code": "EUR",
    "current_state": "to_pay_not_shipped",
    "url_order_details": "https://api.blomming.com/v1/sell/shop/orders/21FE38636H91KJ296",
    "locale": "es",
    "image_url": "http://1.bp.blogspot.com/-ivx8sPkrN0E/T7oWeBCAwKI/AAAAAAAAAfw/aZoBDKIIB3o/s1600/File.png",
    "newsletter": true
  }
]

Response Parameters

  • Type: array
  • Items

    The orders (paginated) on the given status (if any) received by the shop

    • Required: yes
    • order_id

      The Order ID

      • Required: yes
      • Type: string
      • Example: 79
    • num_products

      The number of products present inside the Order

      • Required: yes
      • Type: integer
      • Example: 1
    • price

      The total price of the Order (shipping costs excluded) in the seller’s currency (the same as currency_code response property).

      • Required: yes
      • Type: string
      • Example: "23.50"
    • currency_code

      The currency code of the seller, that is the one the prices on the Order are expressed in

      • Required: yes
      • Type: string
      • Example: "EUR"
    • current_state

      The current Order state

      • Required: yes
      • Type: string
      • Example: "to_pay_not_shipped"
      • oneOf: ["archived", "closed", "to_pay_not_shipped", "to_pay_shipped", "to_ship_not_paid", "to_ship_paid"]
    • url_order_details

      The URL to fetch the details of the Order

      • Required: yes
      • Type: string
      • Format: uri
      • Example: "https://api.blomming.com/v1/sell/shop/orders/21FE38636H91KJ296"
    • locale

      The locale used by the buyer of the Order

      • Required: yes
      • Type: string
      • Example: "es"
    • image_url

      The URL of the image of the first product beloging to the Order

      • Required: no
      • Type: string
      • Format: uri
      • Example: "http://1.bp.blogspot.com/-ivx8sPkrN0E/T7oWeBCAwKI/AAAAAAAAAfw/aZoBDKIIB3o/s1600/File.png"
    • newsletter

      newsletter flag status

      • Required: no
      • Type: boolean
      • Example: true

Response Codes

Successful Response Codes

Failure Response Codes