Skip to content

Locations

Warehouses, shops and pickup points. Every example sets SOOQUNA_TOKEN from the environment; see authentication. Responses are from a test store, cut to two items per list.

Endpoint Method Path
Create a location POST /locations
List locations GET /locations
Get a location GET /locations/{id}
Update a location PATCH /locations/{id}
Deactivate a location POST /locations/{id}/deactivate
Activate a location POST /locations/{id}/activate
Delete a location DELETE /locations/{id}

POST /locations · Scope: write_locations

Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/locations" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "West Bay shop",
"address": {
"address1": "Diplomatic Street, Tower 2",
"city": "Doha",
"country_code": "QA",
"phone": "+97444001100"
},
"fulfils_online_orders": true,
"pickup_enabled": true,
"pickup_instructions": "Ask at the counter.",
"pickup_ready_time": "1h"
}'
Response 201
{
"address": {
"address1": "Diplomatic Street, Tower 2",
"address2": "",
"city": "Doha",
"company": "",
"country_code": "QA",
"extra": {},
"first_name": "",
"last_name": "",
"latitude": null,
"longitude": null,
"phone": "",
"province_code": "",
"zip": ""
},
"fulfils_online_orders": true,
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000023",
"is_active": true,
"name": "West Bay shop",
"on_hand": 0,
"phone": "",
"pickup_enabled": true,
"pickup_instructions": "Ask at the counter.",
"pickup_ready_time": "1h",
"position": 1,
"stocked_items": 0,
"updated_at": "2026-10-18T09:30:00Z",
"version": 1
}

GET /locations · Scope: read_locations

Terminal window
curl -X GET "https://api.sooquna.com/admin/api/2026-10/locations" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"data": [
{
"address": {
"address1": "Diplomatic Street, Tower 2",
"address2": "",
"city": "Doha",
"company": "",
"country_code": "QA",
"extra": {},
"first_name": "",
"last_name": "",
"latitude": null,
"longitude": null,
"phone": "",
"province_code": "",
"zip": ""
},
"fulfils_online_orders": true,
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000023",
"is_active": true,
"name": "West Bay shop",
"on_hand": 0,
"phone": "",
"pickup_enabled": true,
"pickup_instructions": "Ask at the counter.",
"pickup_ready_time": "1h",
"position": 1,
"stocked_items": 0,
"updated_at": "2026-10-18T09:30:00Z",
"version": 1
}
]
}

GET /locations/{id} · Scope: read_locations

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X GET "https://api.sooquna.com/admin/api/2026-10/locations/0193a1b2-c810-7698-8039-998bb6c1a849" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"address": {
"address1": "Street 220, Building 14",
"address2": "",
"city": "Al Wakrah",
"company": "",
"country_code": "QA",
"extra": {},
"first_name": "",
"last_name": "",
"latitude": null,
"longitude": null,
"phone": "",
"province_code": "",
"zip": ""
},
"fulfils_online_orders": true,
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000021",
"is_active": true,
"name": "Al Wakrah warehouse",
"on_hand": 0,
"phone": "",
"pickup_enabled": true,
"pickup_instructions": "Collect from the side gate, 9am–9pm.",
"pickup_ready_time": "2h",
"position": 2,
"stocked_items": 0,
"updated_at": "2026-10-18T09:30:00Z",
"version": 1
}

PATCH /locations/{id} · Scope: write_locations

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X PATCH "https://api.sooquna.com/admin/api/2026-10/locations/0193a1b2-c810-7698-8039-998bb6c1a849" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "Al Wakrah warehouse", "pickup_enabled": false, "version": 1}'
Response 200
{
"address": {
"address1": "",
"address2": "",
"city": "",
"company": "",
"country_code": "QA",
"extra": {},
"first_name": "",
"last_name": "",
"latitude": null,
"longitude": null,
"phone": "",
"province_code": "",
"zip": ""
},
"fulfils_online_orders": false,
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000021",
"is_active": true,
"name": "Al Wakrah warehouse",
"on_hand": 0,
"phone": "",
"pickup_enabled": false,
"pickup_instructions": "",
"pickup_ready_time": "1h",
"position": 2,
"stocked_items": 0,
"updated_at": "2026-10-18T09:30:00Z",
"version": 2
}

POST /locations/{id}/deactivate · Scope: write_locations

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/locations/0193a1b2-c810-7698-8039-998bb6c1a849/deactivate" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"address": {
"address1": "",
"address2": "",
"city": "",
"company": "",
"country_code": "QA",
"extra": {},
"first_name": "",
"last_name": "",
"latitude": null,
"longitude": null,
"phone": "",
"province_code": "",
"zip": ""
},
"fulfils_online_orders": false,
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000021",
"is_active": false,
"name": "Al Wakrah warehouse",
"on_hand": 0,
"phone": "",
"pickup_enabled": false,
"pickup_instructions": "",
"pickup_ready_time": "1h",
"position": 2,
"stocked_items": 0,
"updated_at": "2026-10-18T09:30:00Z",
"version": 3
}

POST /locations/{id}/activate · Scope: write_locations

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/locations/0193a1b2-c810-7698-8039-998bb6c1a849/activate" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"address": {
"address1": "",
"address2": "",
"city": "",
"company": "",
"country_code": "QA",
"extra": {},
"first_name": "",
"last_name": "",
"latitude": null,
"longitude": null,
"phone": "",
"province_code": "",
"zip": ""
},
"fulfils_online_orders": false,
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000021",
"is_active": true,
"name": "Al Wakrah warehouse",
"on_hand": 0,
"phone": "",
"pickup_enabled": false,
"pickup_instructions": "",
"pickup_ready_time": "1h",
"position": 2,
"stocked_items": 0,
"updated_at": "2026-10-18T09:30:00Z",
"version": 4
}

DELETE /locations/{id} · Scope: write_locations

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X DELETE "https://api.sooquna.com/admin/api/2026-10/locations/0193a1b2-c810-7698-8039-998bb6c1a849" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"

Was this page helpful?