Order Lines

Create Order Line

Adds a new line to an existing goodsout.

POST

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

Create Order Line

curl --request POST \
  --url https://public-api.bladepro.io/v1/orders/goodsouts/{id}/lines \
  --header 'Content-Type: application/json' \
  --data '
{
  "discount": 123,
  "discount_type": "<any>",
  "net_unit_principal": 123,
  "principal_tax": 123,
  "quantity": 123,
  "variation": "<any>"
}
'

{
  "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,}

Body

discountnumber

The amount of discount to be applied to the line principal value.

discount_typeany

The type of discount to apply.

net_unit_principalnumberrequired

The net amount paid for a single one of these items.

principal_taxintegerrequired

The ID of the tax that should be applied to the line principal value.

quantityintegerrequired

The quantity ordered.

variationanyrequired

Product description

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