Locations

Warehouses and stores of the company, with the codes used in shipments and availability.

Base URL, authentication and conventions of this API are on the Commerce API page.

Endpoints

get/locationsList locations

get/locations

List locations

Requires the locations:read scope.

Every warehouse and store of the company, by code. Scope locations:read.

GET https://api-commerce.nucleoplatform.com/api/commerce/v1/locations

Authentication: Bearer token

Rate limit: 600 requests per 1m, per connection — Default limit; ask Nucleo support if you need another one.

Responses

200The locations.application/json
Headers
- X-Request-Id The id of this call. Quote it if you contact support; errors repeat it as request_id.
- dataarray of Locationrequired
  Attributes of each item
  codestring
  namestring
  kindstring
  One ofwarehousestoremarketplace
  fulfills_onlineboolean
  Whether it ships online orders.
401unauthorized: the key is missing or wrong, or the call comes from an IP outside the connection's allowlist.application/json
Headers
- X-Request-Id The id of this call. Quote it if you contact support; errors repeat it as request_id.
- errorobjectrequired
  Child attributes
  codestringrequired
  Machine-readable code. Branch on this, never on message.
  
  messagestringrequired
  request_idstringrequired
  detailsobject
  For validation_failed, the messages per parameter.
403The key is right but cannot do this: insufficient_scope (the key lacks the scope of the call), connection_paused or connection_not_active (the connection is paused or not turned on yet). application/json
Headers
- X-Request-Id The id of this call. Quote it if you contact support; errors repeat it as request_id.
- errorobjectrequired
  Child attributes
  codestringrequired
  Machine-readable code. Branch on this, never on message.
  
  messagestringrequired
  request_idstringrequired
  detailsobject
  For validation_failed, the messages per parameter.
429rate_limited: wait for the seconds in Retry-After.application/json
Headers
- X-Request-Id The id of this call. Quote it if you contact support; errors repeat it as request_id.
- Retry-After Seconds to wait before the next call.
- errorobjectrequired
  Child attributes
  codestringrequired
  Machine-readable code. Branch on this, never on message.
  
  messagestringrequired
  request_idstringrequired
  detailsobject
  For validation_failed, the messages per parameter.

Request

curl -X GET https://api-commerce.nucleoplatform.com/api/commerce/v1/locations \
  -H "Authorization: Bearer $NUCLEO_ACCESS_TOKEN" \
  -H 'Accept: application/json'

const res = await fetch("https://api-commerce.nucleoplatform.com/api/commerce/v1/locations", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.NUCLEO_ACCESS_TOKEN}`,
    Accept: "application/json",
  },
});
const data = await res.json();
console.log(res.status, data);

<?php

require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-commerce.nucleoplatform.com/api/commerce/v1/locations', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('NUCLEO_ACCESS_TOKEN'),
        'Accept' => 'application/json',
    ],
    'http_errors' => false,
]);

echo $response->getStatusCode(), PHP_EOL;
echo $response->getBody();

Response

{
  "data": [
    {
      "code": "MI01",
      "name": "Milan flagship",
      "kind": "store",
      "fulfills_online": true
    },
    {
      "code": "WH1",
      "name": "Main warehouse",
      "kind": "warehouse",
      "fulfills_online": true
    }
  ]
}

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "request_id": "1f7e3c2a-9b8d-4e6f-a5c4-3b2a1d0e9f8c"
  }
}

{
  "error": {
    "code": "insufficient_scope",
    "message": "This API key does not have the orders:read scope.",
    "request_id": "1f7e3c2a-9b8d-4e6f-a5c4-3b2a1d0e9f8c"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests: retry after the number of seconds in Retry-After.",
    "request_id": "1f7e3c2a-9b8d-4e6f-a5c4-3b2a1d0e9f8c"
  }
}

Was this page helpful?