Order

Full order details.

HTTP GET

GET https://api.bootic.net/v1/shops/{shop_id}/orders/{code}

Use this relation to load the full details for an order and its dependent resources.

This relation is only available for orders owned by your current access token (admin scope).

$ curl -X GET -H "Authorization: Bearer xxxx" -i https://api.bootic.net/v1/shops/10/orders/R12312

Status: 200 OK
Content-Type: application/json; charset=utf-8
Connection: keep-alive
ETag: "0728e2965bd03e20a7f1c33add2f8775"
Last-Modified: Fri, 20 Jun 2014 22:34:14 GMT
Cache-Control: must-revalidate, private, max-age=0
Date: Wed, 31 Jul 2013 21:11:52 GMT
X-OAuth-Scopes: admin
{
  "_links": {
    "self": {
      "href": "https://api.bootic.net/v1/shops/10/orders/R1C3964"
    },
    "btc:update_order": {
      "href": "https://api.bootic.net/v1/shops/10/orders/R1C3964",
      "method": "put"
    },
    "btc:web_cart": {
      "href": "http://www.acme.com/cart/R1C3964",
      "type": "text/html"
    },
    "btc:web_checkout": {
      "href": "https://checkout.bootic.net/orders/R1C3964",
      "type": "text/html"
    }
  },
  "id": 583085,
  "shop_id": 29,
  "code": "R1C3964",
  "status": "checkout",
  "net_total": 29990,
  "total": 33704,
  "created_on": "2013-10-19T11:06:18.000Z",
  "updated_on": "2013-10-19T11:20:14.000Z",
  "pending_on": null,
  "closed_on": null,
  "shipped_on": null,
  "shipping_total": 3714,
  "shipping_description": "",
  "discount_total": 100,
  "tracking_code": null,
  "courier_name": null,
  "shipped_email_sent": false,
  "closed_email_sent": false,
  "fulfillment": {
    "fulfillment_method": "shipping"
  },
  "payment_info": {
    "name": "Webpay",
    "type": "webpay",
    "data": {
      "tbk_numero_cuotas": 1,
      "tbk_codigo_autorizacion": "abc",
      "tbk_id_transaccion": 3222,
      "tbk_tipo_pago": "VD"
    }
  },
  "_embedded": {
    "address": {
      "street": "Av. Brasil 20",
      "street_2": "4to piso",
      "locality_name": "Valparaiso",
      "region_name": "Valparaiso",
      "country_name": "Chile",
      "postal_code": null,
      "country_code": "CL"
    },
    "contact": {
      "name": "Joe Bloggs",
      "email": "joe@bloggs.com",
      "phone_number": "12322222222"
    },
    "promotion": {
      "name": "Summer discount",
      "discount": 100,
      "discount_type": "$",
      "free_shipping": false
    },
    "discounts": [

    ],
    "line_items": [
      {
        "_links": {
          "product": {
            "href": "https://api.bootic.net/v1/shops/29/products/130924-tinto"
          }
        },
        "product_id": 31166,
        "product_title": "130924 Tinto",
        "unit_price": 29990,
        "units": 3,
        "discount_total": 100,
        "net_total": 89970,
        "total": 89870,
        "product_weight_in_grams": 1400,
        "variant_id": 1234,
        "variant_title": "39",
        "variant_sku": "SXDD3",
        "requested_units": 3,
        "_embedded": {
          "discounts": [
            {
              "class": [
                "discount"
              ],
              "amount": 100,
              "description": "Super offer!"
            }
          ],
          "image": {
            "class": [
              "image",
              "asset"
            ],
            "links": {
              "thumbnail": {
                "href": "http://cdn.bootic.net/29/thumbnail/73763-_MG_4360.JPG"
              },
              "small": {
                "href": "http://cdn.bootic.net/29/small/73763-_MG_4360.JPG"
              },
              "medium": {
                "href": "http://cdn.bootic.net/29/medium/73763-_MG_4360.JPG"
              },
              "large": {
                "href": "http://cdn.bootic.net/29/large/73763-_MG_4360.JPG"
              },
              "original": {
                "href": "http://cdn.bootic.net/29/original/73763-_MG_4360.JPG"
              }
            },
            "file_name": "_MG_4360.JPG",
            "title": ""
          }
        }
      }
    ]
  }
}

Fulfillment

The fulfillment.fulfillment_method property can be one of the following values:

If it is local_pickup, the fulfillment object will also have a nested pickup_data property. Example:

{
  "fulfillment": {
    "fulfillment_method": "local_pickup",
    "pickup_data": {
      "person_name": "Joe Bloggs",
      "name": "Main shop",
      "address": "Some address string 123"
    }
  }
}

Payment info

If available, the payment_info property contains standard name and type properties, example:

{
  "payment_info": {
    "name": "Webpay",
    "type": "webpay"
  }
}

Additionaly it may contain a data property with whatever data was returned by the payment gateway, lower-cased:

{
  "payment_info": {
    "name": "Webpay",
    "type": "webpay",
    "data": {
      "tbk_numero_cuotas": 1,
      "tbk_codigo_autorizacion": "abc",
      "tbk_id_transaccion": 3222,
      "tbk_tipo_pago": "VD"
    }
  }
}
self
Link to this resource
btc:web_cart
HTML cart, human-editable
btc:web_checkout
HTML checkout UI, human-editable
btc:update_order
Update order resource