Skip to main content

Get a product by identifier

GET 

/api/v1/sdk/products/:productId

This endpoint retrieves detailed information for a specific product by ID.

Authentication: Requires Private API Key (sk_*)

Response Data:

  • Product details: name, description, images, status
    • All variants with pricing and inventory
    • External IDs for product and variants
    • Metadata and custom fields
    • Creation and update timestamps

Use Cases:

  • Retrieving product details for display
    • Verifying product synchronization
    • Checking inventory and pricing
    • Product data validation

Error Scenarios:

  • 404 NOT FOUND - Product not found (Error code: PRODUCT_NOT_FOUND)
    • 400 BAD REQUEST - Invalid product ID format (Error code: INVALID_REQUEST)
    • 401 UNAUTHORIZED - Invalid or missing API key (Error code: INVALID_API_KEY)
    • 403 FORBIDDEN - API key doesn't have access to this store (Error code: NO_STORE_ACCESS)

Request​

Responses​

Product retrieved successfully with all details