Get Product by Product Ref

Retrieves a single product by your product_ref.

SecurityOAuth2-Production or OAuth2-Demo
Request
path Parameters
merchant_id
required
string

The merchant identifier the product belongs to.

product_ref
required
string

Your reference for the product (product_ref).

header Parameters
x-api-key
required
string

Your Carriyo API key for authentication.

tenant-id
required
string

Your unique tenant identifier in Carriyo.

Responses
200

The product record.

404

No product found for the supplied product_ref.

get/products/{merchant_id}/product-ref/{product_ref}
Request samples 
Response samples 
application/json
{
  • "tenant": "string",
  • "merchant": "string",
  • "product_id": "string",
  • "product_ref": "string",
  • "sku": "string",
  • "description": "string",
  • "barcode": "string",
  • "image_link": "string",
  • "hs_code": "string",
  • "origin_country": "string",
  • "manufacturer_id": "string",
  • "material_composition": "string",
  • "category": "string",
  • "dangerous_goods": true,
  • "battery": {
    },
  • "digital": true,
  • "non_returnable": true,
  • "status": "ACTIVE",
  • "weight": {
    },
  • "dimension": {
    },
  • "do_not_place_above": true,
  • "do_not_place_below": true,
  • "carriyo_metadata": [
    ],
  • "creation_date": "2019-08-24T14:15:22Z",
  • "update_date": "2019-08-24T14:15:22Z",
  • "creation_source": {
    },
  • "update_source": {
    }
}