Skip to main content

Remove a line item​

Remove a line item from an order. Because line items are considered immutable via the API, an edit is performed as a removal followed by the creation of a new line item.

Path Parameters
  • lineItemId number required

    The Corso ID for a Line Item associated with an order.

    Example: 12345
  • orderId number required

    The Corso ID for an order record.

    Example: 428334
Request Body
  • sourceCanceledOn string required
Responses

OK

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

Loading...