We are on company holidays from December 20th, 2024 to January 10th, 2025 and until then we wish you a Merry Christmas and a Happy New Year 2025.

Transfer products via REST API

You have the option to generate an API key for each of your customers and use 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 https://www.punchcommerce.de/api/v1/products. Authentication takes place via the Bearer token, which is displayed in your PunchCommerce customer.

Get Products

GET https://www.punchcommerce.de/api/v1/products

Retrieve Product

GET https://www.punchcommerce.de/api/v1/products/{ordernumber}

{
    "brand_ordernumber": "",
    "category": "Leisure & Electronic",
    "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": "PSC",
    "weight": 0.17000000000000001,
    "classification_type": "UNSPSC",
    "classification": "43232403",
    "shipping_time": 3,
    "active": true
}

Create product

POST https://www.punchcommerce.de/api/v1/products

{
    "brand_ordernumber": "",
    "category": "Leisure & Electronic",
    "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": "PSC",
    "weight": 0.17000000000000001,
    "shipping_time": 3,
    "classification_type": "UNSPSC",
    "classification": "43232403",
    "active": true
}

Update Product

PUT https://www.punchcommerce.de/api/v1/products/{ordernumber}

{
    "brand_ordernumber": "",
    "category": "Leisure & Electronic",
    "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": "PSC",
    "weight": 0.17000000000000001,
    "shipping_time": 3,
    "classification_type": "UNSPSC",
    "classification": "43232403",
    "active": true
}

Delete all products

DELETE https://www.punchcommerce.de/api/v1/products

Delete one product

DELETE https://www.punchcommerce.de/api/v1/products/{ordernumber}

Composer Bundle

The PunchCommerce client library as a composer bundle can be found in our git repository at https://stash.netzdirektion.de/scm/pun/punchcommerce-client-php.git

Units of Measure

We recommend using UN/CEFACT units for labeling items. A full list of units can be found at the link below:

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 by a "|" be separated from each other. The path is interpreted as nesting from left to right.

Example:

Living|Kitchen|Electronics

becomes

  • Living
    • Kitchen
      • Electronics
PunchCommerce® ist ein Produkt der Netzdirektion GmbH