Izettle

Product Library API

The Product Library API is used for managing merchant's product information and product images.

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Product Library API is used for managing merchant's product information and product images.

Endpoints 32

categories

  • GETRetrieve all categories/organizations/:organizationUuid/categories/v2
  • POSTCreate a new category/organizations/:organizationUuid/categories/v2
  • DELETEDelete a category/organizations/:organizationUuid/categories/v2/:categoryUuid
  • PATCHRename a category/organizations/:organizationUuid/categories/v2/:categoryUuid

discounts

  • GETRetrieve all discounts/organizations/:organizationUuid/discounts
  • POSTCreate a discount/organizations/:organizationUuid/discountsCreates a single discount entity. The location of the newly created discount will be available in the successful response as a HttpHeaders.LOCATION header
  • GETRetrieve a single discount/organizations/:organizationUuid/discounts/:discountUuidGet the full discount with the provided UUID. The method supports conditional GET through providing a HttpHeaders.IF_NONE_MATCH header. If the conditional…
  • PUTUpdate a single discount/organizations/:organizationUuid/discounts/:discountUuidUpdates a discount entity using JSON merge patch (https://tools.ietf.org/html/rfc7386). This means that only included fields will be changed: null values…
  • DELETEDelete a single discount /organizations/:organizationUuid/discounts/:discountUuid

images

  • GETRetrieve all library item images/organizations/:organizationUuid/imagesRetrieves all library items images used by the organization, sorted by updated date

import

  • GETGet status for latest import/organizations/:organizationUuid/import/status
  • GETGet status for an import/organizations/:organizationUuid/import/status/:importUuid
  • POSTImport library items/organizations/:organizationUuid/import/v2

library

  • GETRetrieve the entire library/organizations/:organizationUuid/library?eventLogUuid=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=500&offset=string&all=trueWill return the entire library for the authenticated user. If size of the library exceeds server preferences (normally 500) or the value of the optional limit…

products

  • GETRetrieve all products visible in POS/organizations/:organizationUuid/products
  • POSTCreate a new product/organizations/:organizationUuid/products?returnEntity=false
  • DELETEDelete a list of products/organizations/:organizationUuid/products?uuid=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • GETRetrieve an aggregate of active Options in the library/organizations/:organizationUuid/products/options
  • GETRetrieve all products visible in POS – v2/organizations/:organizationUuid/products/v2?sort=true
  • GETRetrieve the count of existing products/organizations/:organizationUuid/products/v2/count
  • PUTUpdate a single product/organizations/:organizationUuid/products/v2/:productUuidUpdates a product entity using JSON merge patch (https://tools.ietf.org/html/rfc7386). This means that only included fields will be changed: null values…
  • GETRetrieve a single product/organizations/:organizationUuid/products/:productUuidGet the full product with the provided UUID. The method supports conditional GET through providing a HttpHeaders.IF_NONE_MATCH header. If the conditional…
  • DELETEDelete a single product/organizations/:organizationUuid/products/:productUuid

products/online

  • POSTCreate a product identifier/organizations/:organizationUuid/products/online/slugCreates a unique slug (identifier) for a product. The slug is used to create a product URL

taxes

  • GETGet all available tax rates/v1/taxes
  • POSTCreate new tax rates/v1/taxes
  • GETGet all tax rates and a count of products associated with each/v1/taxes/count
  • GETGet the organization tax settings /v1/taxes/settings
  • PUTUpdate the organization tax settings/v1/taxes/settings
  • GETGet a single tax rate/v1/taxes/:taxRateUuid
  • PUTUpdate a single tax rate/v1/taxes/:taxRateUuid
  • DELETEDelete a single tax rate/v1/taxes/:taxRateUuid

API details

Base URL
https://products.izettle.com
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
Operations
32 operations on 20 pathsGET 16POST 6DELETE 5PUT 4PATCH 1
Main resources
products 9taxes 8discounts 5categories 4import 3images 1library 1products/online 1
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Product Library API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Product Library API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve all categories” (GET /organizations/:organizationUuid/categories/v2), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Product Library API?

The Product Library API is used for managing merchant's product information and product images. It is listed under E-commerce and has 32 endpoints.

Who publishes the Product Library API?

It is listed from Izettle's public API description (an OpenAPI document), not published by Izettle on Swastik Codes. Anyone who controls izettle.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Product Library API?

Requests go to https://products.izettle.com. Endpoint paths are added to this base URL.

How do I authenticate with the Product Library API?

With OAuth 2.0 (authorization code flow) with 2 scopes.

How many endpoints does the Product Library API have?

32 operations on 20 paths (16 GET, 6 POST, 5 DELETE, 4 PUT, 1 PATCH). The largest groups are products, taxes, discounts, categories.

Is forking the Product Library API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.