Purchase Orders

Cancel a Purchase Order

Cancel a purchase order.

PUT

/v1/purchase_orders/{id}/cancel

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

{
  "data": {
    "approved_date": "2019-11-25T14:52:56.000Z",
    "comments": "Sample comments.",
    "completed_date": "2019-11-25T14:52:56.000Z",
    "created": "2019-11-25T14:52:56.000Z",
    "currency_id": 1,
    "discount": 0,
    "discount_type": "value",
    "id": 125,
    "modified": "2019-11-25T14:52:56.000Z",
    "notification_email_addresses": "support.team@i-fulfilment.co.uk",
    "product_channel_id": 12,
    "product_component_supplier_id": 500,
    "purchase_order_type_id": 1,
    "reject_reason": null,
    "status": "open",
    "warehouse_id": 1
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

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

Path Parameters

idstringrequired

Path parameter: id

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

Body

reasonstringrequired

Reason for cancellation.

Response

successful operation

approved_dateany

Date the purchase order was accepted on.

channelobject

Product channel details.

Show child attributes

commentsstring

Comments.

completed_dateany

Date of completion.

createdany

Created date.

currencyobject

Currency.

currency_idnumber

Currency ID.

discountnumber

Discount amount.

discount_typeenum<string>

Discount type.

Available options: percentage, value

goodsinsany

List of goodsins.

idnumber

ID.

linesany

Ordered lines.

modifiedany

Last modified date.

notification_email_addressesstring

Notification email address.

paymentsany

Payments made to suppliers.

product_channel_idnumber

ID of the product channel.

product_component_supplier_idnumber

Supplier ID.

purchase_order_type_idnumber

ID of the purchase order type.

referencesany

List of references.

reject_reasonstring

Reason for rejecting the purchase order.

statusenum<string>

Purchase order status.

Available options: draft, cancelled, awaiting_approval, awaiting_booking, rejected, open, completed, discrepancies, pending_completion

supplierobject

Supplier.

Show child attributes

tagsany

List of applied tags.

typeobject

Purchase order type.

Show child attributes

warehouseobject

Warehouse.

warehouse_idnumber

Warehouse ID.

Still need help? Share an idea