Skip to content

Push a branch by your keys

PUT
/api/integration/v1/customers/{ref}/branches/{branchRef}
curl --request PUT \
--url https://api.slflo.com/api/integration/v1/customers/CUST-0042/branches/CUST-0042-02 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: example' \
--data '{ "address": "4 Mosadak St, Dokki", "blocked": false, "contact_name": "Hassan", "credit_limit": null, "latitude": 30.0385, "longitude": 31.2101, "name": { "ar": "سوق الأمل، الدقي", "en": "Al Amal Market, Dokki" }, "payment_terms_days": 30, "phone": "+201001234567", "price_list_ref": null, "radius_metres": 100, "source_version": "2026-10-05T10:40:00Z" }'

Null overrides read the account’s. Needs customers:write. Send an Idempotency-Key header; a retry with the same key and body answers the first answer again, with Idempotent-Replayed: true.

ref
required
string

Your key for the customer the branch belongs to.

Example

CUST-0042
branchRef
required
string

Your key for the branch (delivery address) of that customer.

Example

CUST-0042-02
Idempotency-Key
required
string

Your key for this write, at most 100 characters (an order id or journal id works well). Required on every write; kept 7 days. Same key and body: the first answer again. Same key, other body: 422 IDEMPOTENCY_KEY_REUSED.

Media typeapplication/json
object
address
string
blocked
required
boolean
contact_name
string
credit_limit
number
latitude
number format: double
longitude
number format: double
name
required
object
key
additional properties
string
payment_terms_days
integer format: int32
phone
string
price_list_ref
string
radius_metres
integer format: int32
source_version
string

Example

{
"address": "4 Mosadak St, Dokki",
"blocked": false,
"contact_name": "Hassan",
"credit_limit": null,
"latitude": 30.0385,
"longitude": 31.2101,
"name": {
"ar": "سوق الأمل، الدقي",
"en": "Al Amal Market, Dokki"
},
"payment_terms_days": 30,
"phone": "+201001234567",
"price_list_ref": null,
"radius_metres": 100,
"source_version": "2026-10-05T10:40:00Z"
}

Push a branch by your keys

Media typeapplication/json
object
data
required
object
entity
required
string
external_ref
required
string
id
required
string
result
required
string

Example

{
"data": {
"entity": "branch",
"external_ref": "CUST-0042/01",
"id": "C0000001:B01",
"result": "created"
}
}

An error: the code says what, retryable whether to try again.

Media typeapplication/json
object
error
required
object
code
required

Stable code, e.g. SCOPE_MISSING, UNKNOWN_REFERENCE.

string
details
required

Field-level problems: {field, code}.

Array<object>
object
key
additional properties
string
message
required

What happened and how to fix it.

string
request_id
required

Quote it to support; it finds the server log.

string
retryable
required

Whether the same call may succeed later.

boolean

Example

{
"error": {
"code": "SCOPE_MISSING",
"details": [],
"message": "This client does not hold the invoices:read scope.",
"request_id": "req_01J9X4Q7T2M8P3NRT6V5WZ",
"retryable": false
}
}