Delete an attachment of an order

DELETE

/orders/{orderId}/attachments/{attachmentId}

const url = 'https://acme.mykreezalid.com/front_api/v1/orders/4242/attachments/4243';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://acme.mykreezalid.com/front_api/v1/orders/4242/attachments/4243 \
  --header 'Authorization: Bearer <token>'

Deletes one file attached to an order. The signed-in member must be the customer or the vendor of the order; either of them can delete any attachment of the order.

Authorizations

bearerAuth

Parameters

Path Parameters

orderId

required

integer

Identifier of the order.

Example

attachmentId

required

integer

Identifier of the attachment.

Example

Responses

200

The attachment is deleted.

application/json

object

code

integer

status

string

message

string

Example

{
  "code": 200,
  "status": "success",
  "message": "Attachment deleted successfully"
}

403

No signed-in member, or the attachment could not be deleted.

application/json

Error body returned by the Front API when it refuses a request.

object

code

HTTP status code, repeated in the body.

integer

status

string

message

Human-readable reason.

string

Example

{
  "code": 403,
  "status": "error",
  "message": "Token not found in request"
}

422

The attachment does not exist on this order, or the signed-in member is neither the customer nor the vendor of the order.

application/json

Error body returned by the Front API when it refuses a request.

object

code

HTTP status code, repeated in the body.

integer

status

string

message

Human-readable reason.

string

Example

{
  "code": 403,
  "status": "error",
  "message": "Token not found in request"
}