Burq

API Orientation
Walk Through
Webhooks

Burq APIs

Quotes API
- Get Quotespost
Delivery APIs
Store APIs
Delivery Incident APIs
Connected Account Invitation APIs
- Create Connected Account Invitationpost
- Get Connected Account Invitationget
Order APIs (Beta)

Burq

API Orientation
Walk Through
Webhooks

Burq APIs

Quotes API
- Get Quotespost
Delivery APIs
Store APIs
Delivery Incident APIs
Connected Account Invitation APIs
- Create Connected Account Invitationpost
- Get Connected Account Invitationget
Order APIs (Beta)

List Store

get https://api.burqup.com/v1/stores

API to list stores under the current account

URL Expired

The URL for this request expired after 30 days.

Query Params

starting_after

string

Cursor (object ID) used to retrieve records created before it.

ending_before

string

Cursor (object ID) used to retrieve records created after it.

limit

integer

Number of records per page.

Headers

x-api-key

string

required

Burq API key for your account.

Responses

Response body

object

string

required

ID of the store.

object

string

required

Name of the API resource.

store

name

string

required

Name of the store.

phone_number

string

required

Store phone number that will be forwarded to driver during pickup.

merchant_account_id

string

required

ID of merchant account.

address

string

required

Store address that driver will use for navigation during pickup.

unit_number

string

Unit number of the pickup address.

pickup_notes

string

Notes for driver at pickup location.

merchant_store_id

string

Merchant-provided identifier of the store.

enable_store_payment_method

string

Store need to be paid by a separate payment method

Response body

object

string

A static field that will always have the value of "error"

status

number

The HTTP response status code associated with the error.

type

string

The type of the error. This field is not API-version-controlled. Although rare, the value assignment may change without notice.

code

string

The code of the error. This field is not API-version-controlled. Although rare, the value assignment may change without notice.

message

string

Human-readable description of the error. This field is not API-version-controlled. Error messages are re-worded occasionally for improved readability.

Updated 17 days ago

Create Store

Update Store

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.burqup.com/v1/stores \
3
     --header 'accept: application/json'


xxxxxxxxxx
12
 
1
{
2
  "id": "string",
3
  "object": "store",
4
  "name": "string",
5
  "phone_number": "string",
6
  "merchant_account_id": "string",
7
  "address": "string",
8
  "unit_number": "string",
9
  "pickup_notes": "string",
10
  "merchant_store_id": "string",
11
  "enable_store_payment_method": "string"
12
}

Updated 17 days ago

Create Store

Update Store

Burq
API Orientation
Pagination
Idempotency
Authentication
Rate Limits
API Conventions
Terminology and Concepts
Walk Through
Canceling a Delivery
Checking Delivery Status
Initiating Delivery
Creating Delivery Requests
Generating Quotes
Webhooks

Burq APIs
Quotes API
Get Quotespost
Delivery APIs
Get Deliveryget
List Deliveryget
Cancel Deliverypost
Initiate Deliverypost
Create Deliverypost
Store APIs
Get Storeget
Delete Storedelete
Update Storeput
List Storeget
Create Storepost
Delivery Incident APIs
Get Delivery Incidentget
Create Delivery Incidentpost
List Delivery Incidentsget
Connected Account Invitation APIs
Get Connected Account Invitationget
Create Connected Account Invitationpost
Order APIs (Beta)
Create Quotespost
Accept Order Quotepost
Get Orderget
Update Orderput
Delete Orderdelete
Cancel Orderpost
List Orderget
Create Orderpost

Burq
API Orientation
Pagination
Idempotency
Authentication
Rate Limits
API Conventions
Terminology and Concepts
Walk Through
Canceling a Delivery
Checking Delivery Status
Initiating Delivery
Creating Delivery Requests
Generating Quotes
Webhooks

Burq APIs
Quotes API
Get Quotespost
Delivery APIs
Get Deliveryget
List Deliveryget
Cancel Deliverypost
Initiate Deliverypost
Create Deliverypost
Store APIs
Get Storeget
Delete Storedelete
Update Storeput
List Storeget
Create Storepost
Delivery Incident APIs
Get Delivery Incidentget
Create Delivery Incidentpost
List Delivery Incidentsget
Connected Account Invitation APIs
Get Connected Account Invitationget
Create Connected Account Invitationpost
Order APIs (Beta)
Create Quotespost
Accept Order Quotepost
Get Orderget
Update Orderput
Delete Orderdelete
Cancel Orderpost
List Orderget
Create Orderpost

200The 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.