Orders

Cancel Goodsout

Cancels an order goodsout.

PUT

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

Cancel Goodsout

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

{
  "data": {
    "cancellation_date": "2019-11-25T14:52:56.000Z",
    "date_placed": "2019-11-25T14:52:56.000Z",
    "delivery_instructions": "When not home put in shed.",
    "despatch_date": null,
    "despatch_on_date": null,
    "gift_message": "Happy birthday Sam!<br/>Hope you enjoy this gift.",
    "id": 1049789,
    "retailer_id": null,
    "source": "How the order was created.",
    "status": "awaiting_despatch",
    "type": "consumer"
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

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

Path Parameters

idstringrequired

Path parameter: id

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

Response

successful operation

attributesany

List of attributes.

cancellation_dateany

The date a goodsout was cancelled.

date_placedany

Placed date.

delivery_instructionsstring

Delivery instructions.

despatch_dateany

Despatch date.

despatch_on_dateany

Despatch on date.

gift_messagestring

Gift message.

idnumber

ID.

linesany

List of lines.

orderobject

Order.

retailer_idnumber

ID of the retailer the goodsout is destined for. Null when the goodsout has no retailer.

shipmentsany

List of shipments.

shipping_addressobject

Shipping Address.

Show child attributes

sourcestring

Source.

statusenum<string>

Status.

Available options: draft, awaiting_allocation, hung, returned, awaiting_payment, awaiting_picking, awaiting_despatch, backorder_release, backorder, cancelled, return_open, item_refunded, item_replaced, awaiting_collection, despatched

tagsany

Applied tags.

typeenum<string>

Goodsout type, as set when the goodsout was created.

Available options: consumer, trade, retail

warehouseobject

Warehouse.

Still need help? Share an idea

Path Parameters

Body

Response