6. API Referenz (Stand commerce:seo v5)
Address Formats
HTTP Request | Description | Status |
---|---|---|
GETÂ /shop1/api.php/v2/address_formats | Get Address Formats |
Addresses
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 |
---|---|---|
DELETEÂ /shop1/api.php/v2/cache | Clear Shop Cache |
Attachments
HTTP Request | Description | Status |
---|---|---|
POSTÂ /shop1/api.php/v2/attachments | Upload Attachment |
Categories
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
POSTÂ /shop1/api.php/v2/cronjobs/image_processing | Set ImageProcessing Trigger |
Customer Groups
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
GETÂ /shop1/api.php/v2/orders_history/{order_id} | Get Order History (Single) |
Parcel Services
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 |
---|---|---|
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 |
---|---|---|
GETÂ /shop1/api.php/v2/payment_details/{order_id} | Get Payment Details |
Product Images
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
GETÂ /shop1/api.php/v2/shop_information | Get Shop Information |
Reviews
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
GETÂ /shop1/api.php/v2/zones/{zone_id} | Get Zones |
Impressum: Andreas Kausch, Genthiner Str. 7, 99091 Erfurt, www.commerce-seo.de