Transfer products via REST API | Create OCI and cXML PunchOut Catalogues | PunchCommerce                           ![](//analytics.punchcommerce.de/matomo.php?idsite=1&rec=1)

Transfer products via REST API
==============================

You have the option of generating an API key for each of your customers and using this for the automated transfer of products. A PHP library is currently available as a composer bundle for this purpose.

**API-Url and authentication**

The current version of the REST API is available at . Authentication takes place via the Bearer token, which is displayed in your PunchCommerce customer.

**Retrieve products**

GET

**Get product**

GET }

```
{
    "brand_ordernumber": "",
    "category": "Leisure & Electrical",
    "description_long": null,
    "image_url": null,
    "purchase_unit": null,
    "reference_unit": null,
    "unit": null,
    "unit_name": null,
    "ordernumber": "SW10001",
    "brand": "Shopware Freetime",
    "title": "Main article",
    "description": "Main article",
    "price": 459.94999999999999,
    "tax_rate": 19,
    "packaging_unit": "STCK",
    "weight": 0.17000000000000001,
    "classification_type": "UNSPSC",
    "classification": "43232403",
    "shipping_time": 3,
    "active": true
}
```

**Create product**

POST

```
{
    "brand_ordernumber": "",
    "category": "Leisure & Electrical",
    "description_long": null,
    "image_url": null,
    "purchase_unit": null,
    "reference_unit": null,
    "unit": null,
    "unit_name": null,
    "ordernumber": "SW10001",
    "brand": "Shopware Freetime",
    "title": "Main article",
    "description": "Main article",
    "price": 459.94999999999999,
    "tax_rate": 19,
    "packaging_unit": "STCK",
    "weight": 0.17000000000000001,
    "shipping_time": 3,
    "classification_type": "UNSPSC",
    "classification": "43232403",
    "active": true
}
```

**Update product**

PUT }

```
{
    "brand_ordernumber": "",
    "category": "Leisure & Electrical",
    "description_long": null,
    "image_url": null,
    "purchase_unit": null,
    "reference_unit": null,
    "unit": null,
    "unit_name": null,
    "ordernumber": "SW10001",
    "brand": "Shopware Freetime",
    "title": "Main article",
    "description": "Main article",
    "price": 459.94999999999999,
    "tax_rate": 19,
    "packaging_unit": "STCK",
    "weight": 0.17000000000000001,
    "shipping_time": 3,
    "classification_type": "UNSPSC",
    "classification": "43232403",
    "active": true
}
```

**Delete all products**

DELETE

**Delete a product**

DELETE }

**Composer Bundle**

You can find the PunchCommerce client library as a composer bundle in our Git repository at

**Units of measure**

We recommend using UN/CEFACT units for the labelling of articles. A complete list of units can be found under the following link:

[https://unece.org/fileadmin/DAM/cefact/recommendations/rec20/rec20\_rev3\_Annex3e.pdf](https://unece.org/fileadmin/DAM/cefact/recommendations/rec20/rec20_rev3_Annex3e.pdf)

**Category**

A path of categories can be specified as a category. The individual category names must be separated from each other by a "|". The path is interpreted as nesting from left to right.

Example

Living|Kitchen|Electrical appliances

becomes

- Living
    - Kitchen
        - Electrical appliances

 [ PunchCommerce® ist ein Produkt der ![Netzdirektion GmbH](https://www.punchcommerce.de/static/netzdirektion-logo.png "PunchCommerce® ist ein Produkt der netzdirektion | Gesellschaft für digitale Wertarbeit mbH") ](https://netzdirektion.de)

 [Give feedback now - your opinion helps us to become even better!](https://easy-feedback.de/umfrage/1883200/5FuM95 "Your opinion helps us to become even better!")