Create a branch (sucursal)

Needs shops.write. Creates a branch of type Office that is hidden and is not a fulfillment location (no shipping table, no pickup), so it never appears in the store locator or at checkout. The name must be unique among the seller’s branches; the dealer app uses the convention Empresa · Sucursal.

POST/shops/{shop_id}/branches

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

shop_idintegerrequired

Request body

requiredapplication/json

namestringrequired

Responses

201

The created branch

403

Access denied

422

Blank or used name, or unknown fields

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idpath*

Bodyapplication/json

namestring*

Request

curl -X POST 'https://api.onbolder.com/v2/shops/1/branches' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

const response = await fetch("https://api.onbolder.com/v2/shops/1/branches", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.onbolder.com/v2/shops/1/branches",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\"\n}",
)

Response

The created branch