Remove a pushed branch

DELETE

/api/integration/v1/customers/{ref}/branches/{branchRef}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://api.slflo.com/api/integration/v1/customers/CUST-0042/branches/CUST-0042-02"),
    Headers =
    {
        { "Idempotency-Key", "example" },
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.slflo.com/api/integration/v1/customers/CUST-0042/branches/CUST-0042-02"))
    .header("Idempotency-Key", "example")
    .header("Authorization", "Bearer <token>")
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'https://api.slflo.com/api/integration/v1/customers/CUST-0042/branches/CUST-0042-02';
const options = {
  method: 'DELETE',
  headers: {'Idempotency-Key': 'example', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.slflo.com/api/integration/v1/customers/CUST-0042/branches/CUST-0042-02 \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: example'

Refused with BRANCH_ON_ROUTE while a route still visits it. 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.

Authorizations

bearer

Parameters

Path Parameters

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

Header Parameters

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.

Responses

200

Remove a pushed branch

application/json

object

data

required

object

entity

required

string

external_ref

required

string

required

string

result

required

string

Example

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

default

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

application/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
  }
}