Create Delivery Incident

post

https://api.burqup.com/v1/delivery_incidents

API to create a delivery incident.

Body Params

delivery_id

string

required

Burq-generated id of the delivery.

issue_description

string

Notes or comments that can be used by Burq customer service team to review the incident.

delivery_incident_reason

string

enum

The main reason for opening this delivery incident.

Allowed:

itemized_receipt_image_url

string

required

url of the itemized receipt image. This helps Burq customer support to request refund for your delivery from delivery providers. Please ensure the file is publicly accessible so Burq service can download the image.

Headers

x-api-key

string

required

Burq API key for your account.

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The request was successful.

400Errors under status code 400. See error examples under the "Response" tab on right. Note examples are for reference only. Field values are neither exhaustive nor api-version-controlled.