Create a line item
Add a line item to an existing order, reflecting a change in the order itself.
Path Parameters
- orderId number required
The Corso ID for an order record.
Example: 428334
- application/json
Request Body
- sourceLineItemId string required
The line item ID (from the source system).
- productId string required
The product ID for the line item (from the source system).
- variantId string required
The variant ID for the line item (from the source system). For the line item that represents the Corso Green Shipping Product (if purchased on the order), this should match the corresponding variant ID stored by Corso in our system, so that we can identify the order as protected.
- name string required
The line item name, typically the value shown to the customer representing the product/variant combination purchased.
- quantity number required
The quantity purchased for the line item.
- sku string required
The SKU of product/variant of the line item.
- tax currency required
Any tax applied to the line item.
- vendor string
The vendor of the line item
- price currency required
The price of the line item
- 201
- 400
- 401
- 403
- 404
Created
- application/json
- Schema
- Example (from schema)
Schema
- orderId number required
The ID of the order the line item belongs to in Corso systems.
- lineItemId number required
The ID of the line item in Corso systems.
- sourceCanceledOn date-time
Date/time when the order was canceled in Corso systems.
- createdOn date-time
Date/time when the order was created Corso systems.
- updatedOn date-time
Date/time when the order was created in Corso systems.
- sourceLineItemId string required
The line item ID (from the source system).
- productId string required
The product ID for the line item (from the source system).
- variantId string required
The variant ID for the line item (from the source system). For the line item that represents the Corso Green Shipping Product (if purchased on the order), this should match the corresponding variant ID stored by Corso in our system, so that we can identify the order as protected.
- name string required
The line item name, typically the value shown to the customer representing the product/variant combination purchased.
- quantity number required
The quantity purchased for the line item.
- sku string required
The SKU of product/variant of the line item.
- tax currency required
Any tax applied to the line item.
- vendor string
The vendor of the line item
- price currency required
The price of the line item
{
"orderId": 18372912,
"lineItemId": 18372912,
"sourceCanceledOn": "2022-01-01T17:32:28Z",
"createdOn": "2022-01-01T17:32:28Z",
"updatedOn": "2022-01-01T17:32:28Z",
"sourceLineItemId": "990986",
"productId": "pro-33320",
"variantId": "var-4569876332",
"name": "Shorts - color: blue, size: small",
"quantity": 1,
"sku": "ITEM-12345",
"tax": 1.23,
"vendor": "Nike",
"price": 129.53
}
Bad Request
Unauthorized
Forbidden
Not Found