6. API Referenz (Stand commerce:seo v5)

Address Formats

HTTP Request

Description

Status

HTTP Request

Description

Status

GET /shop1/api.php/v2/address_formats

Get Address Formats

Addresses

HTTP Request

Description

Status

HTTP Request

Description

Status

POST /shop1/api.php/v2/addresses

Create Address

GET /shop1/api.php/v2/addresses

Get Addresses (Multiple)

PUT /shop1/api.php/v2/addresses/{address_id}

Update Address

DELETE /shop1/api.php/v2/addresses/{address_id}

Delete Address

GET /shop1/api.php/v2/addresses/{address_id}

Get Address (Single)

Cache

HTTP Request

Description

Status

HTTP Request

Description

Status

DELETE /shop1/api.php/v2/cache

Clear Shop Cache

Attachments

HTTP Request

Description

Status

HTTP Request

Description

Status

POST /shop1/api.php/v2/attachments

Upload Attachment

Categories

HTTP Request

Description

Status

HTTP Request

Description

Status

POST /shop1/api.php/v2/categories

Create Categories



PUT /shop1/api.php/v2/categories

Update Category (Multiple)



GET /shop1/api.php/v2/categories

Get Categories (Multiple)

PUT /shop1/api.php/v2/categories/{category_id}

Update Category



GET /shop1/api.php/v2/categories/{category_id}

Get Categories (Single)



GET /shop1/api.php/v2/categories/{category_id}/children

Get Category Children



GET /shop1/api.php/v2/categories/{category_id}/products

Get Category Products



DELETE /shop1/api.php/v2/categories/{category_ids}

Delete Categories



POST /shop1/api.php/v2/categories/search

Search Categories



Category Icons

HTTP Request

Description

Status

HTTP Request

Description

Status

PUT /shop1/api.php/v2/category_icons

Rename Icon File



POST /shop1/api.php/v2/category_icons

Upload Category Icon



DELETE /shop1/api.php/v2/category_icons

Delete Category Icon



GET /shop1/api.php/v2/category_icons

Get Category Icons

Category Images

HTTP Request

Description

Status

HTTP Request

Description

Status

PUT /shop1/api.php/v2/category_images

Rename Image File



POST /shop1/api.php/v2/category_images

Upload Category Image



DELETE /shop1/api.php/v2/category_images

Delete Category Image



GET /shop1/api.php/v2/category_images

Get Category Images

Countries

HTTP Request

Description

Status

HTTP Request

Description

Status

GET /shop1/api.php/v2/countries/{country_id}

Get Countries (Single)

GET /shop1/api.php/v2/countries/{country_id}/zones

Get Countries Zones

Cronjobs

HTTP Request

Description

Status

HTTP Request

Description

Status

POST /shop1/api.php/v2/cronjobs/image_processing

Set ImageProcessing Trigger

Customer Groups

HTTP Request

Description

Status

HTTP Request

Description

Status

PATCH /shop1/api.php/v2/customer_groups/{customer_group_id}

Updates CustomerGroup entity



POST /shop1/api.php/v2/customer_groups

Create CustomerGroups



DELETE /shop1/api.php/v2/customer_groups/{customer_group_id}

Delete Customer Groups



GET /shop1/api.php/v2/customer_groups/{customer_group_id}

Get customer groups

Customers

HTTP Request

Description

Status

HTTP Request

Description

Status

POST /shop1/api.php/v2/customers

Create Customers



PUT /shop1/api.php/v2/customers

Update Customers (Multiple)



GET /shop1/api.php/v2/customers

Get Customers

PUT /shop1/api.php/v2/customers/{customer_id}

Update Customer



GET /shop1/api.php/v2/customers/{customer_id}

Get Customer (Single)



DELETE /shop1/api.php/v2/customers/{customer_ids}

Delete Customers



POST /shop1/api.php/v2/customers/search

Search Customers



Emails

HTTP Request

Description

Status

HTTP Request

Description

Status

PUT /shop1/api.php/v2/emails

Queue Email



POST /shop1/api.php/v2/emails/{email_id}

Send Email



DELETE /shop1/api.php/v2/emails/{email_id}

Delete Email



GET /shop1/api.php/v2/emails/{email_id}

Get Emails

Manufacturers

HTTP Request

Description

Status

HTTP Request

Description

Status

PATCH /shop1/api.php/v2/manufacturers/{manufacturer_id}

Updates Manufacturers



POST /shop1/api.php/v2/manufacturers

Create Manufacturers



GET /shop1/api.php/v2/manufacturers

Get Manufacturers (Multiple)

DELETE /shop1/api.php/v2/manufacturers/{manufacturer_id}

Delete Manufacturers



GET /shop1/api.php/v2/manufacturers/{manufacturer_id}

Get Manufacturers



POST /shop1/api.php/v2/manufacturers/search

Search Manufacturers



Order Statuses

HTTP Request

Description

Status

HTTP Request

Description

Status

POST /shop1/api.php/v2/order_statuses

Create Order Status



GET /shop1/api.php/v2/order_statuses

Get order statuses (Multiple)

PUT /shop1/api.php/v2/order_statuses/{order_status_id}

Update Order Status



DELETE /shop1/api.php/v2/order_statuses/{order_status_id}

Delete Order Status



GET /shop1/api.php/v2/order_statuses/{order_status_id}

Get order statuses (Single)



Orders History

HTTP Request

Description

Status

HTTP Request

Description

Status

GET /shop1/api.php/v2/orders_history/{order_id}

Get Order History (Single)

Parcel Services

HTTP Request

Description

Status

HTTP Request

Description

Status

POST /shop1/api.php/v2/parcel_services

Create Parcel Service



GET /shop1/api.php/v2/parcel_services

Get Parcel Services (Multiple)

PUT /shop1/api.php/v2/parcel_services/{parcel_service_id}

Updates Parcel Service



DELETE /shop1/api.php/v2/parcel_services/{parcel_service_id}

Delete Parcel Service



GET /shop1/api.php/v2/parcel_services/{parcel_service_id}

Get Parcel Service (Single)



POST /shop1/api.php/v2/parcel_services/search

Search Parcel Services



Orders

HTTP Request

Description

Status

HTTP Request

Description

Status

PATCH /shop1/api.php/v2/orders/{order_id}/status

Update Order Status



POST /shop1/api.php/v2/orders

Create Order



GET /shop1/api.php/v2/orders

Get Orders (Multiple)

PUT /shop1/api.php/v2/orders/{order_id}

Update Order



DELETE /shop1/api.php/v2/orders/{order_id}

Delete Order



GET /shop1/api.php/v2/orders/{order_id}

Get Order (Single)



GET /shop1/api.php/v2/orders/{order_id}/history

Get Order History (Multiple)



GET /shop1/api.php/v2/orders/{order_id}/history/{history_id}

Get Order History (Single)



POST /shop1/api.php/v2/orders/{order_id}/items

Create Order Item



GET /shop1/api.php/v2/orders/{order_id}/items

Get Order Items (Multiple)



PUT /shop1/api.php/v2/orders/{order_id}/items/{item_id}

Update Order Item



DELETE /shop1/api.php/v2/orders/{order_id}/items/{item_id}

Delete Order Item



GET /shop1/api.php/v2/orders/{order_id}/items/{item_id}

Get Order Item (Single)



POST /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes

Create Order Item Attribute



PUT /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/{attribute_id}/Property

Update Order Item Attribute/Property



DELETE /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/{attribute_id}/Property

Delete Order Item Attribute/Property



GET /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/{attribute_id}/Property

Get Order Item Attribute/Property (Single)



GET /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/Property

Get Order Item Attributes/Properties (Multiple)



GET /shop1/api.php/v2/orders/{order_id}/payment_details

Get Order Payment Details



POST /shop1/api.php/v2/orders/{order_id}/totals

Create Order Total



GET /shop1/api.php/v2/orders/{order_id}/totals

Get Order Totals (Multiple)



PUT /shop1/api.php/v2/orders/{order_id}/totals/{total_id}

Update Order Total



DELETE /shop1/api.php/v2/orders/{order_id}/totals/{total_id}

Delete Order Total



GET /shop1/api.php/v2/orders/{order_id}/totals/{totals_id}

Get Order Total



POST /shop1/api.php/v2/orders/{order_id}/tracking_code

Create Order Tracking Code (deprecated)



GET /shop1/api.php/v2/orders/{order_id}/tracking_code

Get Order Tracking Codes (Multiple) (deprecated)



POST /shop1/api.php/v2/orders/{order_id}/tracking_codes

Create Order Tracking Code



GET /shop1/api.php/v2/orders/{order_id}/tracking_codes

Get Order Tracking Codes (Multiple)



POST /shop1/api.php/v2/orders/search

Search Orders



Payment Details

HTTP Request

Description

Status

HTTP Request

Description

Status

GET /shop1/api.php/v2/payment_details/{order_id}

Get Payment Details

Product Images

HTTP Request

Description

Status

HTTP Request

Description

Status

PUT /shop1/api.php/v2/product_images

Rename Image File



POST /shop1/api.php/v2/product_images

Upload Product Image



DELETE /shop1/api.php/v2/product_images

Delete Product Image



GET /shop1/api.php/v2/product_images

Get Product Images

Product Prices

HTTP Request

Description

Status

HTTP Request

Description

Status

PUT /shop1/api.php/v2/product_prices/{product_id}

Update Product Prices



DELETE /shop1/api.php/v2/product_prices/{product_id}

Delete Product Prices



GET /shop1/api.php/v2/product_prices/{product_id}

Get Product Prices

GET /shop1/api.php/v2/product_prices/{product_id}/customer_groups/{customer_group_id}/{quantity}

Get Graduated Product Price



Quantity Units

HTTP Request

Description

Status

HTTP Request

Description

Status

PATCH /shop1/api.php/v2/quantity_units/{quantity_unit_id}

Updates Quantity Units



POST /shop1/api.php/v2/quantity_units

Create Quantity Units



GET /shop1/api.php/v2/quantity_units

Get Quantity Units (Multiple)

DELETE /shop1/api.php/v2/quantity_units/{quantity_unit_id}

Delete Quantity Units



GET /shop1/api.php/v2/quantity_units/{quantity_unit_id}

Get Quantity Units (Single)



Products

HTTP Request

Description

Status

HTTP Request

Description

Status

POST /shop1/api.php/v2/products

Create Products



PUT /shop1/api.php/v2/products

Update Products (Multiple)



GET /shop1/api.php/v2/products

Get Products

PUT /shop1/api.php/v2/products/{product_id}

Update Product



GET /shop1/api.php/v2/products/{product_id}

Get Products

POST /shop1/api.php/v2/products/{product_id}/links

Create Product Link



PUT /shop1/api.php/v2/products/{product_id}/links

Update Product Link



DELETE /shop1/api.php/v2/products/{product_id}/links

Delete Product Link



GET /shop1/api.php/v2/products/{product_id}/links

Get Product Links

PUT /shop1/api.php/v2/products/{product_id}/product_prices

Update Product Prices



GET /shop1/api.php/v2/products/{product_id}/product_prices

Get Product Prices

GET /shop1/api.php/v2/products/{product_id}/product_prices/customer_groups/{customer_group_id}/{quantity}

Get Graduated Product Price



DELETE /shop1/api.php/v2/products/{product_ids}

Delete Products (Multiple)



POST /shop1/api.php/v2/products/search

Search Products



Shop Information

HTTP Request

Description

Status

HTTP Request

Description

Status

GET /shop1/api.php/v2/shop_information

Get Shop Information

Reviews

HTTP Request

Description

Status

HTTP Request

Description

Status

POST /shop1/api.php/v2/reviews

Create Review



GET /shop1/api.php/v2/reviews

Get Reviews (Multiple)

PUT /shop1/api.php/v2/reviews/{review_id}

Update Review



DELETE /shop1/api.php/v2/reviews/{review_id}

Delete Review



GET /shop1/api.php/v2/reviews/{review_id}

Get Review (Single)



Special Offers

HTTP Request

Description

Status

HTTP Request

Description

Status

POST /shop1/api.php/v2/special_offers

Create Special Offers



GET /shop1/api.php/v2/special_offers

Get Special Offers (Multiple)

DELETE /shop1/api.php/v2/special_offers/{special_offer_id}

Removes Special Offers



PUT /shop1/api.php/v2/special_offers/{special_offer_id}

Updates Special Offers



GET /shop1/api.php/v2/special_offers/{special_offer_id}

Get Special Offers

POST /shop1/api.php/v2/special_offers/search

Search Special Offer



Tax

HTTP Request

Description

Status

HTTP Request

Description

Status

GET /shop1/api.php/v2/tax_classes

Get Tax Classes

GET /shop1/api.php/v2/tax_rates

Get Tax Rates

GET /shop1/api.php/v2/tax_zones

Get Tax Zones

Tracking Code

HTTP Request

Description

Status

HTTP Request

Description

Status

GET /shop1/api.php/v2/tracking_code

Get Tracking Codes (Multiple) (deprecated)

DELETE /shop1/api.php/v2/tracking_code/{tracking_code_id}

Delete Tracking Code (deprecated)



GET /shop1/api.php/v2/tracking_code/{tracking_code_id}

Get Tracking Code (Single) (deprecated)



Tracking Codes

HTTP Request

Description

Status

HTTP Request

Description

Status

GET /shop1/api.php/v2/tracking_codes

Get Tracking Codes (Multiple)

DELETE /shop1/api.php/v2/tracking_codes/{tracking_code_id}

Delete Tracking Code



GET /shop1/api.php/v2/tracking_codes/{tracking_code_id}

Get Tracking Code (Single)



Vpe

HTTP Request

Description

Status

HTTP Request

Description

Status

PATCH /shop1/api.php/v2/vpe/{vpe_id}

Updates VPE



POST /shop1/api.php/v2/vpe

Create VPE

DELETE /shop1/api.php/v2/vpe/{vpe_id}

Delete VPE



GET /shop1/api.php/v2/vpe/{vpe_id}

Get VPE (Single)



Withdrawal

HTTP Request

Description

Status

HTTP Request

Description

Status

POST /shop1/api.php/v2/withdrawals

Create Withdrawal

GET /shop1/api.php/v2/withdrawals

Get Withdrawals (Multiple)



PUT /shop1/api.php/v2/withdrawals/{withdrawal_id}

Update Withdrawal



DELETE /shop1/api.php/v2/withdrawals/{withdrawal_id}

Delete Withdrawal



GET /shop1/api.php/v2/withdrawals/{withdrawal_id}

Get Withdrawal (Single)



Zones

HTTP Request

Description

Status

HTTP Request

Description

Status

GET /shop1/api.php/v2/zones/{zone_id}

Get Zones



Impressum: Andreas Kausch, Genthiner Str. 7, 99091 Erfurt, www.commerce-seo.de