Line Items

The Line Item is an object used to represent someProductadded to anOrder. Line Item is validated against the product it is created from. Several properties (like name and description) are copied from the product, afterwards the relationship between products and line items is not maintained.

With every order, there might be any number of Line Items.

Line Items, Products and Orders are available only to users who are on theEnterpriseplan.

Account's administrators can disable changes to these entities in the account'ssettings. When disabled, all data are preserved but only GET requests are allowed.

JSON format

Retrieve order's line items

             

              
GET/v2/orders/:order_id/line_items
             

Returns all line items associated to order.

Parameters

Allowed for

• Agents

Using cURL

             

              
curl-v -X GET https://api.getbase.com/v2/orders/:order_id/line_items\-H"Accept: application/json"\-H"Authorization: Bearer$ACCESS_TOKEN"
             

Example response

             

              
HTTP/1.1200OKContent-Type:application/json; charset=utf-8Content-Language:en{"items":[{"data":{"id":1,"name":"Enterprise Plan","sku":"enterprise-plan","description":"Includes more storage options","value":"3599.99","variation":"0.00","price":"3599.99","currency":"USD","quantity":10,"created_at":"2014-08-27T16:32:56Z","updated_at":"2014-08-27T17:32:56Z"},"meta":{"type":"line_item"}}],"meta":{"type":"collection","count":1,"links":{"self":"http://api.getbase.com/v2/orders/1/line_items?page=1&per_page=25"}}}
             

---

Create a line item

             

              
POST/v2/orders/:order_id/line_items
             

Adds a new line item to an existing order. Line items correspond to products in the catalog, so first you must createproducts. Because products allow defining different prices in different currencies, when creating a line item, the parametercurrencyis required.

If request does not specifyvaluenorvariation, we'll assumevariationis0(no markup), and setvalueto the price of the product. Price is picked based on the providedcurrency.

If eithervalueorvariationis provided, the other value is computed based on the price from the product. You can also specify both, in which case we do no calculations.

In all cases, we do check that thevalueis obtained from thepriceby applying the markup equal tovariation. We also check thatvariationis withinmax_discountandmax_markup, if these are set for the product.

Parameters

Allowed for

• Agents

Using cURL

             

              
curl-v -X POST https://api.getbase.com/v2/orders/1/line_items\-H"Accept: application/json"\-H"Content-Type: application/json"\-H"Authorization: Bearer$ACCESS_TOKEN"\-d'{"data": {"product_id": 1,"value": "3599.99","currency": "USD","variation": "0.00","quantity": 10},"meta": {"type": "line_item"}}'
             

Example response

             

              
HTTP/1.1200OKContent-Type:application/json; charset=utf-8Content-Language:en{"data":{"id":1,"name":"Enterprise Plan","sku":"enterprise-plan","description":"Includes more storage options","value":"3599.99","variation":"0.00","price":"3599.99","currency":"USD","quantity":10,"created_at":"2014-08-27T16:32:56Z","updated_at":"2014-08-27T17:32:56Z"},"meta":{"type":"line_item"}}
             

---

Retrieve a single line item

             

              
GET/v2/orders/:order_id/line_items/:line_item_id
             

Returns a single line item of an order, according to the unique line item ID provided.

Parameters

Allowed for

• Agents

Using cURL

             

              
curl-v -X GET https://api.getbase.com/v2/orders/1/line_items/2\-H"Accept: application/json"\-H"Authorization: Bearer$ACCESS_TOKEN"
             

Example response

             

              
HTTP/1.1200OKContent-Type:application/json; charset=utf-8Content-Language:en{"data":{"id":1,"name":"Enterprise Plan","sku":"enterprise-plan","description":"Includes more storage options","value":"3599.99","variation":"0.00","price":"3599.99","currency":"USD","quantity":10,"created_at":"2014-08-27T16:32:56Z","updated_at":"2014-08-27T17:32:56Z"},"meta":{"type":"line_item"}}
             

---

Update order's line item

             

              
PUT/v2/orders/:order_id/line_items/:line_item_id
             

更新一个相关联的行项目订单。

Parameters

Allowed for

• Agents

Using cURL

             

              
curl-v -X PUT https://api.getbase.com/v2/orders/:order_id/line_items/:line_item_id\-H"Accept: application/json"\-H"Authorization: Bearer$ACCESS_TOKEN"\-H"Content-Type: application/json"\-d'{"data": {"product_id": 1,"value": "3599.99","currency": "USD","variation": "0.00","quantity": 10},"meta": {"type": "line_item"}}'
             

Example response

             

              
HTTP/1.1200OKContent-Type:application/json; charset=utf-8Content-Language:en{"items":[{"data":{"id":1,"name":"Enterprise Plan","sku":"enterprise-plan","description":"Includes more storage options","value":"3599.99","variation":"0.00","price":"3599.99","currency":"USD","quantity":10,"created_at":"2014-08-27T16:32:56Z","updated_at":"2014-08-27T17:32:56Z"},"meta":{"type":"line_item"}}],"meta":{"type":"collection","count":1,"links":{"self":"http://api.getbase.com/v2/orders/1/line_items?page=1&per_page=25"}}}
             

---

Remove a line item

             

              
DELETE/v2/orders/:order_id/line_items/:line_item_id
             

Remove an order's line item. This operation cannot be undone.

Parameters

Allowed for

• Agents

Using cURL

             

              
curl-v -X DELETE https://api.getbase.com/v2/orders/1/line_items/2\-H"Authorization: Bearer$ACCESS_TOKEN"
             

Example response

             

              
HTTP/1.1204NoContent
             

---