Get Stock for Product

GET 
https://euwest.api.elasticpath.com/v2/inventories/:product_uuid

Gets the stock for the product matching the specified unique identifier.

Request

Path Parameters

product_uuid UUIDrequired

The unique identifier of the product.

Responses

200

Success. Returns the stock for the given product UUID

application/json

Schema

Schema

data objectrequired
idUUID (string)required
The unique identifier.
Example: 00000000-0000-0000-0000-000000000000
typeStockType (string)required
Possible values: [stock]
Default value: stock
Example: stock
attributes objectrequired
availableint64required
Example: 20
allocatedint64required
Example: 10
totalint64required
Example: 30
locations object
property name* object
availableint64required
Example: 20
allocatedint64required
Example: 10
totalint64required
Example: 30
meta objectrequired
stock_idUUID (string)required
The unique identifier.
Example: 00000000-0000-0000-0000-000000000000
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": "stock",
    "attributes": {
      "available": 20,
      "allocated": 10,
      "total": 30,
      "locations": {}
    },
    "meta": {
      "stock_id": "00000000-0000-0000-0000-000000000000",
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z"
      }
    }
  }
}

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"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

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"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

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.Get, "https://euwest.api.elasticpath.com/v2/inventories/:product_uuid");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
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

product_uuid — pathrequired

ResponseClear

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