Product API

You can access and manipulate product information in a Uphance account for a single product. You can retrieve details including product variations, pricing and SKUs.

Retrieve a single product

Retrieve details for an existing product, including product variations, pricing and SKUs.

$ curl https://api.uphance.com/products/PRODUCT_ID \
    -H "Authorization: ACCESS_TOKEN"

Example response:

{
  "product": {
    "id": 3344,
    "product_identifier": "",
    "name": "New nameoo2",
    "description": "desc243 asdf222",
    "sizing_system": "S, M, L",
    "image_url": "https:// ...",
    "not_for_sale": false,
    "season_id": 2035,
    "variations": [
      {
        "id": 4224,
        "color": "Red",
        "textile_content": "100% Cotton",
        "prices": [
          {
            "wsp_money": "45.00",
            "msrp_money": "6.00",
            "name": "Wholesale",
            "currency": "USD"
          },
          {
            "wsp_money": "7.00",
            "msrp_money": "8.00",
            "name": "Wholesale",
            "currency": "GBP"
          }
        ],
        "skus": [
          {
            "id": 8119,
            "color": "Red",
            "size": "S",
            "ean": "",
            "in_stock": 0,
            "available_to_sell": 0,
            "available_to_sell_from_stock": 0
          },
          {
            "id": 8120,
            "color": "Red",
            "size": "M",
            "ean": "",
            "in_stock": 0,
            "available_to_sell": 0,
            "available_to_sell_from_stock": 0
          },
          {
            "id": 8121,
            "color": "Red",
            "size": "L",
            "ean": "",
            "in_stock": 0,
            "available_to_sell": 0,
            "available_to_sell_from_stock": 0
          }
        ]
      },
      {
        "id": 4225,
        "color": "Blue",
        "textile_content": "100% Cotton",
        "prices": [ ... ],
        "skus": [ ... ]
      },
      {
        "id": 4226,
        "color": "Green",
        "textile_content": "100% Cotton",
        "prices": [ ... ],
        "skus": [ ... ]
      }
    ]
  }
}

Retrieve a product by Product Identifier

Retrieve details for a product by passing in the product identifier.

$ curl https://api.uphance.com/products/?filter[product_identifier]= PRODUCT_IDENTIFIER \
    -H "Authorization: ACCESS_TOKEN"

List all products

Retrieve details for all products, optionally filtered in some way. This endpoint will return 100 products at most (see the Pagination section to learn how to access all pages).

$ curl https://api.uphance.com/products \
    -H "Authorization: ACCESS_TOKEN"

You can pass filter parameters to scope the products returned. All filter parameters have the format filter[name] where name is some attribute to filter on. For example, the following request filters the requested products by season ID number.

$ curl https://api.uphance.com/products?filter[season_id]=SEASON_ID \
    -H "Authorization: ACCESS_TOKEN"

SKUs

Retrieve a single SKU

Retrieve details for an existing SKU.

$ curl https://api.uphance.com/skus/SKU_ID \
    -H "Authorization: ACCESS_TOKEN"

Example response:

{
  "sku" : {
    "id": 1967,
    "color": "White Stripe",
    "size": "XXL",
    "ean": "8365987370003",
    "in_stock": 8,
    "available_to_sell": 2,
    "available_to_sell_from_stock": 2
  }
}

Retrieve a SKU by EAN or UPC

Retrieve details for an existing SKU by passing in EAN or UPC.

$ curl https://api.uphance.com/skus?filter[ean]=EAN/UPC\
    -H "Authorization: ACCESS_TOKEN"

List all SKUs

Retrieve details for all SKUs, optionally filtered in some way. This endpoint will return 500 SKUs at most (see the Pagination section to learn how to access all pages).

$ curl https://api.uphance.com/skus \
    -H "Authorization: ACCESS_TOKEN"

Filter by product:

$ curl https://api.uphance.com/skus?filter[product_id]=PRODUCT_ID \
    -H "Authorization: ACCESS_TOKEN"

Filter by season:

$ curl https://api.uphance.com/skus?filter[season_id]=SEASON_ID \
    -H "Authorization: ACCESS_TOKEN"

Seasons

GET all Seasons

$ curl https://api.uphance.com/seasons \
    -H "Authorization: ACCESS_TOKEN"