Sites & Organisation

External Id Types

Endpoints for managing external ID types

get/shop/external-id-types

List external ID types

listExternalIdTypes

This endpoint lists all the ExternalIdTypes which are associated with the provided site.

Query parameters

site_iduuidoptional
Get external IDs for the given site.
archivedbooleanoptional
Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The external ID types were successfully retrieved
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/external-id-types" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/external-id-types', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/external-id-types",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/external-id-types', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/external-id-types", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The external ID types were successfully retrieved

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "key": "my_external_system",
      "name": "My External System",
      "description": "ID of the basket in my external system",
      "applies_to": "basket",
      "site_ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "all_sites": false,
      "is_archived": true
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "Unauthenticated"
}

post/shop/external-id-types

Create a new external ID type

createExternalIdType

Use this endpoint to create a new ExternalIdType.

Request body

namestringrequired
Display name of the external ID type, shown to staff in the admin UI alongside the IDs themselves. Use a clear system-of-record label (e.g. "Salesforce CRM"). 1-120 characters.
descriptionstringoptionalnullable
Optional help text shown next to the external ID type in the admin UI to explain to staff what the ID represents and where it comes from. Plain text, up to 500 characters.
applies_tostringrequired
The type of object the external ID type applies to.
Possible values:basket
site_idsstring[]optional
all_sitesbooleanoptional
Whether the external ID type should be associated with all sites.

Responses

201
The external ID type was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/external-id-types" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My External System",
  "description": "ID of the basket in my external system",
  "applies_to": "basket",
  "site_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "all_sites": false
}'

const response = await fetch('https://api.playground.try.be/shop/external-id-types', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "My External System",
    "description": "ID of the basket in my external system",
    "applies_to": "basket",
    "site_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "all_sites": false
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/external-id-types",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "My External System",
        "description": "ID of the basket in my external system",
        "applies_to": "basket",
        "site_ids": [
            "00000000-0000-0000-0000-000000000000"
        ],
        "all_sites": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/external-id-types', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'My External System',
            'description' => 'ID of the basket in my external system',
            'applies_to' => 'basket',
            'site_ids' => [
                '00000000-0000-0000-0000-000000000000'
            ],
            'all_sites' => false
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "My External System",
		"description": "ID of the basket in my external system",
		"applies_to": "basket",
		"site_ids": []interface{}{
			"00000000-0000-0000-0000-000000000000",
		},
		"all_sites": false,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/external-id-types", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The external ID type was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "key": "my_external_system",
    "name": "My External System",
    "description": "ID of the basket in my external system",
    "applies_to": "basket",
    "site_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "all_sites": false,
    "is_archived": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/external-id-types/{externalIdType}

Show an external ID type

getExternalIdType

Retrieves an ExternalIdType by ID.

Path parameters

externalIdTypemongo-idrequired
The ID of the ExternalIdType

Responses

200
The external ID type was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/external-id-types/value" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/external-id-types/value', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/external-id-types/value",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/external-id-types/value', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/external-id-types/value", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The external ID type was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "key": "my_external_system",
    "name": "My External System",
    "description": "ID of the basket in my external system",
    "applies_to": "basket",
    "site_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "all_sites": false,
    "is_archived": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

put/shop/external-id-types/{externalIdType}

Update an external ID type

updateExternalIdType

Updates an ExternalIdType by ID.

Path parameters

externalIdTypemongo-idrequired
The ID of the ExternalIdType

Request body

namestringoptional
Display name of the external ID type, shown to staff in the admin UI alongside the IDs themselves. Use a clear system-of-record label (e.g. "Salesforce CRM"). 1-120 characters.
descriptionstringoptionalnullable
Optional help text shown next to the external ID type in the admin UI to explain to staff what the ID represents and where it comes from. Plain text, up to 500 characters.
applies_tostringoptional
The type of object the external ID type applies to.
Possible values:basket
site_idsstring[]optional
all_sitesbooleanoptional
Whether the external ID type should be associated with all sites.

Responses

200
The external ID type was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/external-id-types/value" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My External System",
  "description": "ID of the basket in my external system",
  "applies_to": "basket",
  "site_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "all_sites": false
}'

const response = await fetch('https://api.playground.try.be/shop/external-id-types/value', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "My External System",
    "description": "ID of the basket in my external system",
    "applies_to": "basket",
    "site_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "all_sites": false
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/external-id-types/value",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "My External System",
        "description": "ID of the basket in my external system",
        "applies_to": "basket",
        "site_ids": [
            "00000000-0000-0000-0000-000000000000"
        ],
        "all_sites": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/external-id-types/value', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'My External System',
            'description' => 'ID of the basket in my external system',
            'applies_to' => 'basket',
            'site_ids' => [
                '00000000-0000-0000-0000-000000000000'
            ],
            'all_sites' => false
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "My External System",
		"description": "ID of the basket in my external system",
		"applies_to": "basket",
		"site_ids": []interface{}{
			"00000000-0000-0000-0000-000000000000",
		},
		"all_sites": false,
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/external-id-types/value", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The external ID type was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "key": "my_external_system",
    "name": "My External System",
    "description": "ID of the basket in my external system",
    "applies_to": "basket",
    "site_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "all_sites": false,
    "is_archived": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/external-id-types/{externalIdType}

Archive an external ID type

deleteExternalIdType

Soft deletes an ExternalId by ID.

Path parameters

externalIdTypemongo-idrequired
The ID of the ExternalIdType

Responses

204
The external ID type was successfully archived.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/external-id-types/value" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/external-id-types/value', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/shop/external-id-types/value",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/external-id-types/value', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/shop/external-id-types/value", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The external ID type was successfully archived.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/external-id-types/{externalIdType}/restore

Restore an external id

restoreExternalIdType

Restores an archived (soft-deleted) ExternalIdType by ID.

Path parameters

externalIdTypemongo-idrequired
The ID of the ExternalIdType

Responses

200
The external ID type was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/shop/external-id-types/value/restore" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/external-id-types/value/restore', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/external-id-types/value/restore",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/external-id-types/value/restore', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/external-id-types/value/restore", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The external ID type was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "key": "my_external_system",
    "name": "My External System",
    "description": "ID of the basket in my external system",
    "applies_to": "basket",
    "site_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "all_sites": false,
    "is_archived": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

put/shop/external-id-types/{externalIdType}/sites

Add a site to an external ID type

createExternalIdTypeSite

Enables the ExternalIdType for the given site.

Path parameters

externalIdTypemongo-idrequired
The ID of the ExternalIdType

Request body

site_iduuidrequired
Identifier of the site to associate with this external ID type. Once associated, baskets and other supported objects at this site can carry an external ID of this type.

Responses

200
The external ID type was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/external-id-types/value/sites" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "site_id": "00000000-0000-0000-0000-000000000000"
}'

const response = await fetch('https://api.playground.try.be/shop/external-id-types/value/sites', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "site_id": "00000000-0000-0000-0000-000000000000"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/external-id-types/value/sites",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "site_id": "00000000-0000-0000-0000-000000000000"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/external-id-types/value/sites', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'site_id' => '00000000-0000-0000-0000-000000000000'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"site_id": "00000000-0000-0000-0000-000000000000",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/external-id-types/value/sites", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The external ID type was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "key": "my_external_system",
    "name": "My External System",
    "description": "ID of the basket in my external system",
    "applies_to": "basket",
    "site_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "all_sites": false,
    "is_archived": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/external-id-types/{externalIdType}/sites/{siteId}

Remove a site from an external ID type

deleteExternalIdTypeSite

Disables the the ExternalIdType for the given site.

Path parameters

externalIdTypemongo-idrequired
The ID of the ExternalIdType
siteIduuidrequired
The ID of the Site

Responses

200
The external ID type was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/external-id-types/value/sites/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/external-id-types/value/sites/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/shop/external-id-types/value/sites/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/external-id-types/value/sites/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/shop/external-id-types/value/sites/00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The external ID type was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "key": "my_external_system",
    "name": "My External System",
    "description": "ID of the basket in my external system",
    "applies_to": "basket",
    "site_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "all_sites": false,
    "is_archived": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}