Apinoa Docs

Product

Get one Shopify product from its store: price, every variant, options, images and description.

View raw .mdx
GET | POST /v1/shopify/product

Send parameters as a query string with GET, or as a JSON body with POST. Both are equivalent.

Request

curl "https://gateway.apinoa.com/v1/shopify/product?id=thedoodlebot.com%2Fdoodle-bot" \
  -H "x-api-key: $APINOA_API_KEY"

Parameters

ParameterTypeRequiredNotes
idstringyesA Shopify id rather than a global identifier: the composite shop/handle, e.g. us.giesswein.com/wool-sneaker-women. A search item's id is already in this form, and a full product URL is accepted too.
currencystringPresentment currency, ISO 4217.
regionstringBuyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.

The same parameters, and every response type, are in the OpenAPI document.

Response

Returns Product in data. A real response, shortened: arrays keep their first entries and long text is cut.

{
  "success": true,
  "data": {
    "marketplace": "shopify",
    "id": "thedoodlebot.com/doodle-bot",
    "url": "https://thedoodlebot.com/products/doodle-bot",
    "title": "Doodle Bot Limited Edition",
    "price": {
      "currency": "USD",
      "amount": 80
    },
    "listPrice": {
      "currency": "USD",
      "amount": 140
    },
    "brand": "Doodle Bot",
    "listedAt": "2025-10-06T02:01:18.000Z",
    "inStock": true,
    "description": "<p data-start=\"247\" data-end=\"513\"><strong data-start=\"302\" data-end=\"392\">Doodle Bot is the fun, interactive robot tha…",
    "badges": [],
    "promotions": [],
    "features": [],
    "media": {
      "images": [
        "https://cdn.shopify.com/s/files/1/0785/4070/1921/files/IMG_2729.jpg?v=1759715594",
        "https://cdn.shopify.com/s/files/1/0785/4070/1921/files/IMG_2728.jpg?v=1759715764"
      ],
      "videos": []
    },
    "category": [],
    "attributes": [],
    "options": [
      {
        "id": "1",
        "name": "Color",
        "values": [
          {
            "id": "PINK",
            "name": "PINK"
          },
          {
            "id": "GREEN",
            "name": "GREEN"
          }
        ]
      }
    ],
    "variants": [
      {
        "id": "47235322806497",
        "price": {
          "currency": "USD",
          "amount": 80
        },
        "listPrice": {
          "currency": "USD",
          "amount": 140
        },
        "inStock": true,
        "selections": [
          {
            "optionId": "1",
            "valueId": "PINK",
            "optionName": "Color",
            "valueName": "PINK"
          }
        ]
      },
      {
        "id": "47235322839265",
        "price": {
          "currency": "USD",
          "amount": 80
        },
        "listPrice": {
          "currency": "USD",
          "amount": 140
        },
        "inStock": false,
        "selections": [
          {
            "optionId": "1",
            "valueId": "GREEN",
            "optionName": "Color",
            "valueName": "GREEN"
          }
        ]
      }
    ],
    "offers": [],
    "reviewAspects": [],
    "boxContents": [],
    "reviews": [],
    "seller": {
      "id": "thedoodlebot.com",
      "url": "https://thedoodlebot.com"
    }
  }
}

Errors

StatusCodeMeaning
400INVALID_PARAMSA parameter is missing, unknown or out of range. The message names it.
400INVALID_PRODUCT_IDThe id is not shop/handle or a product URL.
401UNAUTHORIZEDThe x-api-key header is missing, or the key is revoked or unknown.
402INSUFFICIENT_BALANCEThe balance does not cover this call. Top up in the dashboard.
404PRODUCT_NOT_FOUNDThe marketplace has no such product.
429MARKETPLACE_SATURATEDToo many concurrent calls. Retry after the Retry-After seconds.
502UPSTREAM_ERRORThe platform answered with something unusable. Retry with backoff.

Every code is listed in Errors. Failed calls are not billed.

Pricing

Price $0.001 per call. List price; the rate steps down above 1,000 calls a day.

Notes

  • id is shop/handle (thedoodlebot.com/doodle-bot), exactly as a search or catalog item carries it. A full product URL works too.
  • currency pins the store's currency (default USD). The response states the currency the store actually charged in, per price.

On this page