Developer Guides
  • Introduction
    • Welcome
  • Core
    • Overview
    • Frontend
      • Implementation & Testing
      • Using the API endpoints
      • Gift cards
        • Gift Card validation API (Optional)
      • Check stock
      • Sibling products
      • Rewards program
      • Customer signatures
      • Retail transactions
      • Shopify Local Pick-up
  • API
    • Overview
    • Quick Start
    • Accounts
    • Changelog
    • Reference
      • Customers
      • Inventory
      • Orders
      • Products
      • Rewards
      • Stores
      • Vouchers
      • Staff
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. API
  2. Reference

Inventory

PreviousCustomersNextOrders

Last updated 1 year ago

Was this helpful?

Our base domain URL is https://api.dotapparel.io.

Retrieve inventory data of the given SKU from stores

get

Scope: visitor and above

This endpoint retrieves inventory data by accepting a required SKU parameter.

The endpoint checks that the SKU is valid and associated with an existing product record. If the SKU is valid, the endpoint retrieves inventory data for the SKU from multiple stores. The returned data is a list of object that includes the quantity of the SKU in stock, the location of the store, and any other relevant information related to the inventory.

Authorizations
Query parameters
skustringRequired

Shopify SKU number

Header parameters
X-DotApparel-NamestringRequired

An alias name that represents a particular brand that is using the API

shopstringRequired
Responses
200
Successful response
application/json
400
Bad Request: The SKU was invalid.
401
Unauthorized: The user is not authorized to perform this action.
404
Not Found: The inventory with the specified SKU was not found.
get
GET /inventory?sku=text HTTP/1.1
Host: 
Authorization: Basic username:password
X-DotApparel-Name: text
shop: text
Accept: */*
{
  "data": [
    {
      "id": "101-PRD001-BLK-S",
      "sku": "PRD001-BLK-S",
      "storeId": 101,
      "storeNumber": 123,
      "storeName": "Store ABC",
      "freeStock": 30,
      "shopifyBuffer": 1
    }
  ]
}