GET v1​/ sell​/shop​/orders​/:order_number

Returns the details for the specific Order (uniquely identified by :order_number)

Instant gratification

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

Try to fetch an Order of yours
curl -i -H "Authorization: Bearer $BEARER" \
https://api.blomming.com/v1/sell/order/<order_number>

Request

Example Request

{
}

Request Parameters

    Response

    Example Response

    {
      "order_id": "58a1db546fe18e9d",
      "num_products": 2,
      "price": 123,
      "locale": "es",
      "currency_code": "EUR",
      "current_state": "to_pay_not_shipped",
      "url_order_details": "http://example.org/sell/shop/orders/58a1db546fe18e9d",
      "image_url": "http://1.bp.blogspot.com/-ivx8sPkrN0E/T7oWeBCAwKI/AAAAAAAAAfw/aZoBDKIIB3o/s1600/File.png",
      "date": "2013-03-06T14:18:11Z",
      "payment_type": "PayPal",
      "possible_states": [
        "to_pay_and_ship"
      ],
      "shipping_address": {
        "first_name": "Enrico",
        "last_name": "Fermi",
        "street": "via Teodosio 65",
        "postal_code": "20100",
        "province": "MI",
        "city": "Milano",
        "country": "IT",
        "company": "Wikimedia"
      },
      "billing_address": {
        "first_name": "Enrico",
        "last_name": "Fermi",
        "street": "via Teodosio 65",
        "vat_number": "03276121203",
        "postal_code": "20100",
        "province": "MI",
        "city": "Milano",
        "country": "IT",
        "company": "Wikimedia"
      },
      "contact_details": {
        "email": "[email protected]",
        "phone": "12312312312323"
      },
      "products_details": [
        {
          "name": "test",
          "product_url": "https://api.blomming.com/v0/shops/lozoodisimona/items/12345",
          "quantity": 1,
          "image_url": "https://s3.amazonaws.com/cdn-development.blomming.com/items/000/260/816/original/2d03f26f1b98f4a1c7748d53da8753fa.jpeg?1359303458",
          "converted_price": "1212",
          "price": "1212",
          "converted_original_price": "1300",
          "original_price": "1300",
          "user_barcode": "spilla1"
        }
      ],
      "converted_price": 123,
      "subtotal_price": 120,
      "converted_subtotal_price": 120,
      "newsletter": {
      }
    }

    Response Parameters

    • order_id

      The Order number (unique identifier associated to the Order)

      • Required: yes
      • Type: string
      • Example: "58a1db546fe18e9d"
    • num_products

      how many products are present inside the order

      • Required: no
      • Type:
        • number
        • null
      • Example: 2
    • price

      The total price of the Order (shipping cost included)

      • Required: yes
      • Type: integer
      • Example: 123
    • locale

      The locale used by the buyer of the Order

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

      The currency code the prices on the Order are expressed in

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

      The current state of the Order

      • 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 the Order details (must match to the requested path)

      • Required: yes
      • Type: string
      • Format: uri
      • Example: "http://example.org/sell/shop/orders/58a1db546fe18e9d"
    • image_url

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

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

      The date of the Order (that is, when the Order was placed)

      • Required: yes
      • Type: string
      • Format: date-time
      • Example: "2013-03-06T14:18:11Z"
    • payment_type

      The human readable description of the choosen payment type for the Order (localized)

      • Required: yes
      • Type: string
      • Example: "PayPal"
    • possible_states

      A list of possible future states for the Order

      • Required: yes
      • Type: array
      • Items

        A possible state name

        • Required: yes
        • Type: string
        • Example: "to_pay_and_ship"
    • shipping_address

      The shipping address where the Order must be shipped to

      • Required: yes
      • first_name

        The first name of the Order’s addressee

        • Required: yes
        • Type: string
        • Example: "Enrico"
      • last_name

        The last name of the Order’s addressee

        • Required: yes
        • Type: string
        • Example: "Fermi"
      • street

        The street address where the Order must be shipped to

        • Required: yes
        • Type: string
        • Example: "via Teodosio 65"
      • postal_code

        The address code where the Order must be shipped to

        • Required: yes
        • Type: string
        • Example: "20100"
      • province

        The provice or state where the Order must be shipped to

        • Required: yes
        • Type: string
        • Example: "MI"
      • city

        The city where the Order must be shipped to

        • Required: yes
        • Type: string
        • Example: "Milano"
      • country

        The country where the Order must be shipped to

        • Required: yes
        • Type: string
        • Example: "IT"
      • company

        The name of the company associated to the shipping destination

        • Required: no
        • Type:
          • string
          • null
        • Example: "Wikimedia"
    • billing_address

      The billing address associated to the Order

      • Required: no
      • first_name

        The first name of the Order’s billing representative

        • Required: yes
        • Type: string
        • Example: "Enrico"
      • last_name

        The last name of the Order’s billing representative

        • Required: yes
        • Type: string
        • Example: "Fermi"
      • street

        The street address relative to the Order billing

        • Required: yes
        • Type: string
        • Example: "via Teodosio 65"
      • vat_number

        The VAT number the Order is bind to

        • Required: no
        • Type:
          • string
          • null
        • Example: "03276121203"
      • postal_code

        The address code relative to the Order billing

        • Required: yes
        • Type: string
        • Example: "20100"
      • province

        The provice or state relative to the Order billing

        • Required: yes
        • Type: string
        • Example: "MI"
      • city

        The city relative to the Order billing

        • Required: yes
        • Type: string
        • Example: "Milano"
      • country

        The country relative to the Order billing

        • Required: yes
        • Type: string
        • Example: "IT"
      • company

        The name of the company relative to the Order billing

        • Required: no
        • Type:
          • string
          • null
        • Example: "Wikimedia"
    • contact_details

      Informations about how to contact the Order’s addressee

      • Required: yes
      • email

        The email contact of the Order’s addressee

      • phone

        The phone contact of the Order’s addressee

        • Required: no
        • Type: string
        • Example: "12312312312323"
    • products_details

      A lookup into the product present in the Order

      • Required: yes
      • Type: array
      • Items

        A single product present inside the order

        • Required: yes
        • name

          The title of the Item

          • Required: yes
          • Type: string
          • Example: "test"
        • product_url

          The URL to fetch the details of the Item

          • Required: yes
          • Type: string
          • Format: uri
          • Example: "https://api.blomming.com/v0/shops/lozoodisimona/items/12345"
        • quantity

          The number of items of this kind present in the Order

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

          The URL of the image of the Item

          • Required: yes
          • Type: string
          • Example: "https://s3.amazonaws.com/cdn-development.blomming.com/items/000/260/816/original/2d03f26f1b98f4a1c7748d53da8753fa.jpeg?1359303458"
        • converted_price

          The price of the Item, converted to the given currency (if any). If no currency is given, this value is equal to price.

          • Required: yes
          • Type: string
          • Example: "1212"
        • price

          The price of the Item

          • Required: yes
          • Type: string
          • Example: "1212"
        • converted_original_price

          The original price (before discount) of the Item

          • Required: yes
          • Type:
            • null
            • string
          • Example: "1300"
        • original_price

          The original price (before discount) of the Item

          • Required: yes
          • Type:
            • null
            • string
          • Example: "1300"
        • user_barcode

          The user_barcode that uniquely identifies the Item with this variants in the seller shop

          • Required: no
          • Type:
            • string
            • null
          • Example: "spilla1"
    • converted_price

      The total price of the Order (shipping cost included), converted to the given currency (if any). If no currency is given, this value is equal to price.

      • Required: yes
      • Type: number
      • Example: 123
    • subtotal_price

      The total price of the Order (shipping cost excluded)

      • Required: yes
      • Type: number
      • Example: 120
    • converted_subtotal_price

      The total price of the Order (shipping cost excluded), converted to the given currency (if any). If no currency is given, this value is equal to subtotal_price.

      • Required: yes
      • Type: number
      • Example: 120
    • newsletter

      newsletter flag status

      • Required: no
      • Type: bool
      • Example: true

    Response Codes

    Successful Response Codes

    Failure Response Codes