On This Page

Using Line Items

This section describes how to format line items in your API requests.

Some Thunes API requests require line items or allow you include line items in addition to the required request information. Line items are used to include information about the goods that customers purchase, such as product name, quantity, and price.

Line items are included in a request in the

lineItem[]

array.

Figure:

Required Fields for Line Items

These fields are required for each line item included in your request:

orderInformation.lineItems[].productDescription
orderInformation.lineItems[].productName
orderInformation.lineItems[].quantity
orderInformation.lineItems[].taxAmount
orderInformation.lineItems[].totalAmount
orderInformation.lineItems[].typeOfSupply
orderInformation.lineItems[].unitPrice

Including Line Items

This example shows three valid line items in the proper syntax.

Figure:

Line Items within a API Request Message

{
 "orderInformation": {
        "lineItems": [
            {
                "productName": "test-product-1",
                "quantity": 5,
                "productDescription": "description-123",
                "unitPrice": "20",
                "taxAmount": "10",
                "totalAmount": "100",
                "typeOfSupply": "01"
            },
            {
                "productName": "test-product-2",
                "quantity": 1,
                "productDescription": "description-456",
                "unitPrice": "5",
                "taxAmount": "1",
                "totalAmount": "6",
                "typeOfSupply": "01"
            },
            {
                "productName": "test-product-3",
                "quantity": 2,
                "productDescription": "description-789",
                "unitPrice": "4",
                "taxAmount": "2",
                "totalAmount": "10",
                "typeOfSupply": "01"
            }
        ]
    }
}