Create Delivery Incident

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

API to create a delivery incident.

Responses

Response body

object

string

required

ID of the delivery incident.

object

string

required

Name of the API resource.

delivery_incident

status

string

required

Status of the delivery incident.

      * `pending` - status indicates delivery incident is pending a review from Burq.

      * `processing` - status indicates delivery incident is under review from Burq.

      * `resolved` - status indicates delivery incident is reviewed and closed by Burq.

pending processing resolved

ticket_url

string

Burq support ticket URL.

refunded_amount

integer

required

Total refunded amount.

delivery_id

string

required

The unique identifier for the delivery associated with delivery incident

delivery_incident_reason

string

The reason for the delivery incident.

Order Cancelled Never Delivered Order Arrived Late Order Delivered Early Missing or Incorrect Items Poor Delivery Experience Stuck Delivery Status Promotional Offer

issue_description

string

Notes or comments that can be used by the Customer Service team to review the incident.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.burqup.com/v1/delivery_incidents \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
10
 
1
{
2
  "id": "string",
3
  "object": "delivery_incident",
4
  "status": "pending",
5
  "ticket_url": "string",
6
  "refunded_amount": 0,
7
  "delivery_id": "string",
8
  "delivery_incident_reason": "Order Cancelled",
9
  "issue_description": "string"
10
}

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.