Skip to content

Branch Management ​

The Branch APIs allow merchants to manage multiple physical store locations, warehouses, or pickup centers. Each branch can have specific stock inventory, address information, and branch-specific price overrides.

Available Endpoints ​

MethodEndpointDescription
GET/v1/branchesRetrieve all branches for the store.
POST/v1/branchesCreate a new branch.
GET/v1/branches/{id}Retrieve details of a specific branch.
PATCH/v1/branches/{id}Update branch information.
DELETE/v1/branches/{id}Delete a branch.
PATCH/v1/branches/{id}/online-branchDesignate a branch as the online fulfillment branch.
GET/v1/branches/{id}/price-overridesList branch-specific price overrides.
PUT/v1/branches/{id}/price-overridesSet or update a branch-specific price override.
DELETE/v1/branches/{id}/price-overridesClear a branch-specific price override.
GET/v2/branches/lookupPaginated minimal branch lookup for dropdowns and filters.

Build with joy