Skip to content

Latest commit

 

History

History
75 lines (62 loc) · 1.73 KB

product-library.adoc

File metadata and controls

75 lines (62 loc) · 1.73 KB

Product Library API

Service Description

The product library API provides information about a merchant’s products.

Scopes

The Product Library API implements the following scopes:

  • READ:PRODUCT

  • WRITE:PRODUCT


Example Requests

Create product

POST /organizations/self/products

{
  "uuid": "d62f7bb0-2728-11e6-85b5-dd108c223139",
  "categories": ["shoes","clothing"],
  "name": "ProductName",
  "description": "Description of product",
  "imageLookupKeys": [
    "x0yH8KnREeequIvGpnO8Qw.jpg"
  ],
  "presentation" : {
    "imageUrl" : "https://image.izettle.com/productimage/o/x0yH8KnREeequIvGpnO8Qw.jpg",
    "backgroundColor" : "#5f5f5f",
    "textColor" : "#7c7c7c"
  },
  "variants": [
    {
      "uuid": "d635e450-2728-11e6-a84e-d3d803b3d694",
      "name": "VariantName",
      "description": "Description of variant",
      "sku": "SKU",
      "barcode": "Barcode",
      "price": {
        "amount": 10,
        "currencyId": "SEK"
      },
      "costPrice": {
        "amount": 5,
        "currencyId": "SEK"
      }
    }
  ],
  "externalReference": "externalReference",
  "unitName": "Kg",
  "vatPercentage": "10"
}

Update product

PUT /organizations/self/products/v2/{productUuid}

Updates a product entity using JSON merge patch (https://tools.ietf.org/html/rfc7386). This means that only included fields will be changed: null values removes the field on the target entity, and other values updates the field. Uses same format as Create product