Update a Location

PUT 
https://euwest.api.elasticpath.com/v2/inventories/locations/:location_uuid

Updates an Inventory Location

Request

Path Parameters

location_uuid UUIDrequired

The unique identifier of the location.

application/json

Body

data objectrequired
idUUID (string)required
The unique identifier.
Example: 00000000-0000-0000-0000-000000000000
typeInventoryLocationType (string)required
Possible values: [inventory_location]
Example: inventory_location
attributes LocationUpdateAttributesrequired
namestring
Possible values: >= 3 characters and <= 1024 characters
Example: Milton Keynes Warehouse
external_refstringnullable
Possible values: >= 3 characters and <= 1024 characters
Example: mk-stock-warehouse-walnut-tree
slugstring
Possible values: non-empty and <= 128 characters
Example: milton-keynes-warehouse
descriptionstringnullable
Possible values: >= 3 characters and <= 1024 characters
Example: Southern dispatch location for all inventory
addressstring[]nullable
Possible values: >= 1, <= 8
geolocation objectnullable
The longitude and latitude of a location.
latdoublerequired
Example: 51.477928
londoublerequired
Example: -0.001545

Responses

200

Success. The location was updated successfully

application/json

Schema

Schema

data object
idUUID (string)required
The unique identifier.
Example: 00000000-0000-0000-0000-000000000000
typeInventoryLocationType (string)required
Possible values: [inventory_location]
Example: inventory_location
attributes LocationAttributesrequired
namestringrequired
Possible values: >= 3 characters and <= 1024 characters
Example: Milton Keynes Warehouse
external_refstring
Possible values: >= 3 characters and <= 1024 characters
Example: mk-stock-warehouse-walnut-tree
slugstringrequired
Possible values: non-empty and <= 128 characters
Example: milton-keynes-warehouse
descriptionstring
Possible values: >= 3 characters and <= 1024 characters
Example: Southern dispatch location for all inventory
addressstring[]
Possible values: >= 1, <= 8
geolocation objectnullable
The longitude and latitude of a location.
latdoublerequired
Example: 51.477928
londoublerequired
Example: -0.001545
meta object
timestamps Timestampsrequired
updated_atstring
The date and time a resource was updated.
Example: 2017-01-10T11:41:19.244842Z
created_atstringrequired
The date and time a resource was created.
Example: 2017-01-10T11:41:19.244842Z

Example (auto)

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inventory_location",
    "attributes": {
      "name": "Milton Keynes Warehouse",
      "external_ref": "mk-stock-warehouse-walnut-tree",
      "slug": "milton-keynes-warehouse",
      "description": "Southern dispatch location for all inventory",
      "address": [
        "string"
      ],
      "geolocation": {
        "lat": 51.477928,
        "lon": -0.001545
      }
    },
    "meta": {
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z"
      }
    }
  }
}

Example

{
  "data": {
    "id": "ebc7652d-bb7d-4359-9a83-78f2998208d9",
    "type": "inventory_location",
    "attributes": {
      "name": "Milton Keynes Warehouse",
      "external_ref": "mk-stock-warehouse-walnut-tree",
      "slug": "milton-keynes-warehouse",
      "description": "Southern dispatch location for all inventory",
      "address": [
        "Troughton Supplies",
        "38 Pipernel Grove",
        "Walnut Tree",
        "MK7 4UL"
      ],
      "geolocation": {
        "lat": -90,
        "lon": 180
      }
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors object[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": "400",
      "detail": "Your request was invalid"
    }
  ]
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors object[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "No location found"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://euwest.api.elasticpath.com/v2/inventories/locations/:location_uuid");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"id\": \"00000000-0000-0000-0000-000000000000\",\n    \"type\": \"inventory_location\",\n    \"attributes\": {\n      \"name\": \"Milton Keynes Warehouse\",\n      \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n      \"slug\": \"milton-keynes-warehouse\",\n      \"description\": \"Southern dispatch location for all inventory\",\n      \"address\": [\n        \"string\"\n      ],\n      \"geolocation\": {\n        \"lat\": 51.477928,\n        \"lon\": -0.001545\n      }\n    }\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com/v2

Auth

Bearer Token

Parameters

location_uuid — pathrequired

Body

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inventory_location",
    "attributes": {
      "name": "Milton Keynes Warehouse",
      "external_ref": "mk-stock-warehouse-walnut-tree",
      "slug": "milton-keynes-warehouse",
      "description": "Southern dispatch location for all inventory",
      "address": [
        "string"
      ],
      "geolocation": {
        "lat": 51.477928,
        "lon": -0.001545
      }
    }
  }
}

ResponseClear

Click the Send API Request button above and see the response here!