Get supplier images for catalog products

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

v1Operation ID v1_public_real_time_data_fetcher_images

Returns each catalog product's images: local_images (from YoPrint's copy of the catalog) and real_time_images (from the supplier), each with images, color_image, preview_url and provider_meta.

Permission

Any member of the team.

Business rules

• Send 1 to 100 products per request. Every type is db_catalog.
• The answer is 200 once the body is valid; each part says success and errors.
• Images do not depend on the plan. Most suppliers need a working connection under Apps (account_missing or invalid_credentials otherwise).

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 (3)

  • idstringrequired
  • local_imagesobjectrequired

    Images from YoPrint's copy of the catalog.

    Child fields (3)

    • dataobject | nullrequired
      Child fields (4)

      • color_imagestring | null
      • imagesarray of objects
      • preview_urlstring | null
      • provider_metaobject | array | 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
  • real_time_imagesobjectrequired

    Images from the supplier.

    • Same fields as data[].local_images.
• 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.

Related

• POSTLoad a product for a sales order line/v1/api/store/{team_slug}/hydrate_product

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/real_time_data_fetcher/images' \  -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",
      "local_images": {
        "data": {
          "color_image": "https://example.com/swatches/black.jpg",
          "images": [
            {
              "url": "https://example.com/catalog/ssa-B00000001-front.jpg"
            }
          ],
          "preview_url": "https://example.com/catalog/ssa-B00000001-front.jpg",
          "provider_meta": null
        },
        "errors": null,
        "success": true
      },
      "real_time_images": {
        "data": null,
        "errors": [
          {
            "code": "invalid_credentials",
            "message": "ssa Credential Is Not Valid",
            "retryable": false,
            "type": "provider_pre_check_error"
          }
        ],
        "success": false
      }
    },
    {
      "id": "ssa-B00000002",
      "local_images": {
        "data": {
          "color_image": "https://example.com/swatches/black.jpg",
          "images": [
            {
              "url": "https://example.com/catalog/ssa-B00000002-front.jpg"
            }
          ],
          "preview_url": "https://example.com/catalog/ssa-B00000002-front.jpg",
          "provider_meta": null
        },
        "errors": null,
        "success": true
      },
      "real_time_images": {
        "data": null,
        "errors": [
          {
            "code": "invalid_credentials",
            "message": "ssa Credential Is Not Valid",
            "retryable": false,
            "type": "provider_pre_check_error"
          }
        ],
        "success": false
      }
    }
  ],
  "status": 200,
  "success": true
}