Skip to content

Creates a line item

Request

POST {{baseURL}}/pay-int-api/line-items

Security
Bearer
Headers
x-api-versionstring
Bodyapplication/json

The line item creation request.

productNamestring or null

Indicates the name of the item.

Example: RollerMouse Wireless Mouse

Example:"RollerMouse Wireless Mouse"
descriptionstring or null

Indicates a description of the item.

Example: RollerMouse Design Collection, Limited Edition Wireless Mouse

Example:"RollerMouse Design Collection, Limited Edition Wireless Mouse"
skustring or null

Indicates the product identifier item.

Example: 24474771

Example:"24474771"
unitPricenumber, (double)

Indicates the unit price of the item.

Example: 18.99

Example:18.99
unitTypeIdinteger, (int32)

Indicates the identifier of the unit type.

This is a numeric identifier represents the unit of measure for the item. Each supplier provides their own lookup value. That value maps to a predefined unit type in their system.

Example: 1

Example:1
categoryIdstring or null, (uuid)

Indicates the identifier of the item category.

Example: a2d1c4b5-6e7f-4890-9abc-1d2e3f4a5b68

Example:"a2d1c4b5-6e7f-4890-9abc-1d2e3f4a5b68"
taxRatenumber, (double)

Indicates the type of tax rate.

Example: 3.25 (as 3.25%)

Example:3.25
curl -i -X POST \
  https://developer.flute.com/_mock/api-reference/pay-int-api/line-items \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-version: string' \
  -d '{
    "productName": "RollerMouse Wireless Mouse",
    "description": "RollerMouse Design Collection, Limited Edition Wireless Mouse",
    "sku": "24474771",
    "unitPrice": 18.99,
    "unitTypeId": 1,
    "categoryId": "a2d1c4b5-6e7f-4890-9abc-1d2e3f4a5b68",
    "taxRate": 3.25
  }'

Responses

OK

Bodyapplication/json
idstring, (uuid)
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }