Create Store

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

API to create a store

Body Params

name

string

required

Name of the store.

phone_number

string

required

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

address

string

required

Street address of the store. Unit number should be passed through the unit_number property.

unit_number

string

Unit number of the store.

pickup_notes

string

Notes to help drivers during pickup.

merchant_store_id

string

Merchant-provided store identifier. Commonly used for merchants to cross-reference stores from Burq API with their own system.

enable_store_payment_method

boolean

Set this field to true if deliveries from this store need to be paid by a separate payment method. When set to true, Burq also generates separate invoices for deliveries under this store. Note this setting cannot be changed after store is created.

connected_account_id

string

Id of connected account to create the store for. Only applicable for Burq Connect merchants. Connected account stores can be used by platform accounts to create deliveries under their connected accounts.

Headers

x-api-key

string

required

Burq API key for your account.

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.burqup.com/v1/stores \
3
     --header 'accept: application/json' \
4
     --header 'content-type: 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
}

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.

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

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