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 https://www.punchcommerce.de/api/v1/products. Authentication takes place via the Bearer token, which is displayed in your PunchCommerce customer.

Retrieve products

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

Get product

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

{
    "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 https://www.punchcommerce.de/api/v1/products

{
    "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 https://www.punchcommerce.de/api/v1/products/{ordernumber}

{
    "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 https://www.punchcommerce.de/api/v1/products

Delete a product

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

Composer Bundle

You can find the PunchCommerce client library as a composer bundle 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 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

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