DELETE api/orders/{orderNumber}/{branchId}

Delete an order and set any debit order id on associated storage cards to null

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderNumber

integer

Required

branchId

integer

Required

Body Parameters

None.

Remarks

Any order type is allowed, only orders with open status is allowed, only orders without close order type allowed

Example

// Will delete the order with ID 123 on branch 1
http://localhost/api/orders/123/1

Response Information

Resource Description

DeleteOrderResponse detailing success status and any eventual errors

DeleteOrderResponse
NameDescriptionTypeAdditional information
OrderNumber

integer

None.

BranchId

integer

None.

Success

boolean

None.

Error

DeleteOrderError

None.

Response Formats

application/json, text/json

Sample:
{
  "OrderNumber": 1,
  "BranchId": 2,
  "Success": true,
  "Error": null
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.