Order Lines

Cancel Order Line

Cancel a order goodsout line.

PUT

/v1/orders/goodsouts/{id}/lines/{lineId}/cancel

Cancel Order Line

curl --request PUT \
  --url https://public-api.bladepro.io/v1/orders/goodsouts/{id}/lines/{lineId}/cancel \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

{
  "data": {
    "discount": 1.5,
    "discount_type": "percentage",
    "id": 3450345,
    "net_unit_principal": 12,
    "quantity": 4,
    "status": "active",
    "transaction_sku": "GREEN-BALL"
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::ORDERS::MANAGE

Path Parameters

idstringrequired

Path parameter: id

Pattern: [1-9][0-9]{0,}

lineIdstringrequired

Path parameter: lineId

Pattern: [1-9][0-9]{0,}

Body

reasonstringrequired

Reason for canceling the line.

Response

successful operation

discountnumber

Discount amount.

discount_typenumber

Discount type.

idnumber

ID.

itemsany

Line items.

net_unit_principalnumber

Net unit price.

principal_taxobject

Tax rate applied to the line.

quantitynumber

Quantity ordered.

statusenum<string>

Line status.

Available options: active, void

transaction_skustring

SKU used during the transaction.

variationobject

Product variation.

Still need help? Share an idea