Get live supplier inventory for catalog products

POST/v1/api/store/{team_slug}/real_time_data_fetcher/inventory

v1Operation ID v1_public_real_time_data_fetcher_inventory

Returns how many units each supplier has of each catalog product, fetched live: real_time_inventory.data.total_count and warehouses (each with id, name and count). This is the supplier's stock, not yours; for your own stock use Get stock levels for products.

Permission

Any member of the team.

Business rules

• Send 1 to 100 products per request. Every type is db_catalog.
• The answer is always 200 once the body is valid: each product says success and errors for each part. A wrong id comes back as a failed part, not a 404.
• Live data needs two things. The team's plan must include real-time vendor stock and pricing (otherwise "Real Time Pricing is not available for this team plan." or "Real Time Inventory is not available for this team plan."). And the supplier must be connected in Team settings, under Apps, with working credentials (otherwise account_missing or invalid_credentials).
• Suppliers with live data: S&S Activewear (US and Canada), SanMar (US and Canada), Momentec / Augusta Sportswear (US and Canada) and AS Colour (US). AlphaBroder, Conde, TSF and Delta Apparel are no longer live ("Catalog Product is deprecated."); their stored prices still come back in local_pricing.

Side effects

• Calls each supplier's API with your team's credentials; requests to different suppliers run in parallel. Answers are cached for 30 seconds, so a repeat within that time does not call the supplier again.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

application/json, required.

• productarray of objectsrequired
  • 1 to 100 items
  Fields of each item (2)

  • typestringrequired
    • Always "db_catalog"
  • idstringrequired

    A supplier catalog product id: one size and color of a style, such as ssa-B00000001.

Response

200Successful response.

A 200 answer can still be a refusal

Check success (and the fields named below) as well as the HTTP status:

• A product, or one part of its answer, failed: not found, plan, supplier connection, or the supplier's API. The request still answers 200 with success: true; that part has success: false, data: null and its reasons in errors. Fix: Check each part's success. Read errors[].code and message; fix the plan or the connection under Apps, or retry later for provider_unavailable.

• dataarray of objectsrequired
  Fields of each item (2)

  • idstringrequired
  • real_time_inventoryobjectrequired

    Stock at the supplier, fetched live.

    Child fields (3)

    • dataobject | nullrequired
      Child fields (2)

      • total_countinteger
      • warehousesarray of objects
        Fields of each item (4)

        • countinteger
        • idstring | integer | null
        • metadataobject | array

          Supplier-specific details; an empty list [] when there are none.

        • namestring | null
    • errorsarray of objects | nullrequired

      Null when the part succeeded. On a failure, the reasons (an empty list when none was recorded).

      Fields of each item (4)

      • codestring
        • One of: "account_missing", "invalid_credentials", "unsupported_format", "image_not_found", "image_load_failed", "provider_unavailable", "unknown"
      • messagestring

        Readable reason, such as "Real Time Pricing is not available for this team plan.", or internal error when the reason is not shown.

      • retryableboolean

        True for provider_unavailable, image_load_failed and unknown.

      • typestring
    • successbooleanrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  product is missing, empty or has more than 100 items, or a type is not db_catalog. error.code is validation_failed.

  Fix

  Send 1 to 100 items with type: db_catalog.

Notes

• Inventory answers are cached for 30 seconds across all teams, so two teams asking at once may see the same numbers.

Related

• POSTGet live supplier pricing and inventory together/v1/api/store/{team_slug}/real_time_data_fetcher/pricing_with_inventory
• POSTGet stock levels for products/v1/api/store/{team_slug}/product_stock

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/real_time_data_fetcher/inventory' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "product": [      {        "id": "ssa-B00000001",        "type": "db_catalog"      },      {        "id": "ssa-B00000002",        "type": "db_catalog"      }    ]  }'

Example response 200

Response

{
  "data": [
    {
      "id": "ssa-B00000001",
      "real_time_inventory": {
        "data": {
          "total_count": 1250,
          "warehouses": [
            {
              "count": 1000,
              "id": "IL",
              "metadata": [],
              "name": "Illinois"
            },
            {
              "count": 250,
              "id": "NV",
              "metadata": [],
              "name": "Nevada"
            }
          ]
        },
        "errors": null,
        "success": true
      }
    },
    {
      "id": "ssa-B00000002",
      "real_time_inventory": {
        "data": {
          "total_count": 600,
          "warehouses": [
            {
              "count": 600,
              "id": "IL",
              "metadata": [],
              "name": "Illinois"
            }
          ]
        },
        "errors": null,
        "success": true
      }
    }
  ],
  "status": 200,
  "success": true
}