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/0-->0-->0-->0--> | Update Address | |
DELETE /shop1/api.php/v2/addresses/1-->1-->1-->1--> | Delete Address | |
GET /shop1/api.php/v2/addresses/2-->2-->2-->2--> | 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/3-->3-->3-->3--> | Update Category | |
GET /shop1/api.php/v2/categories/4-->4-->4-->4--> | Get Categories (Single) | |
GET /shop1/api.php/v2/categories/5-->5-->5-->5-->/children | Get Category Children | |
GET /shop1/api.php/v2/categories/6-->6-->6-->6-->/products | Get Category Products | |
DELETE /shop1/api.php/v2/categories/7-->7-->7-->7--> | 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/8-->8-->8-->8--> | Get Countries (Single) | |
GET /shop1/api.php/v2/countries/9-->9-->9-->9-->/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/10-->10-->10-->10--> | Updates CustomerGroup entity | |
POST /shop1/api.php/v2/customer_groups | Create CustomerGroups | |
DELETE /shop1/api.php/v2/customer_groups/11-->11-->11-->11--> | Delete Customer Groups | |
GET /shop1/api.php/v2/customer_groups/12-->12-->12-->12--> | 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/13-->13-->13-->13--> | Update Customer | |
GET /shop1/api.php/v2/customers/14-->14-->14-->14--> | Get Customer (Single) | |
DELETE /shop1/api.php/v2/customers/15-->15-->15-->15--> | 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/16-->16-->16-->16--> | Send Email | |
DELETE /shop1/api.php/v2/emails/17-->17-->17-->17--> | Delete Email |
Manufacturers
HTTP Request | Description | Status |
---|---|---|
PATCH /shop1/api.php/v2/manufacturers/ | 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/ | Delete Manufacturers | |
GET /shop1/api.php/v2/manufacturers/ | 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/ | Update Order Status | |
DELETE /shop1/api.php/v2/order_statuses/ | Delete Order Status | |
GET /shop1/api.php/v2/order_statuses/ | Get order statuses (Single) | |
Orders History
HTTP Request | Description | Status |
---|---|---|
GET /shop1/api.php/v2/orders_history/ | 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/ | Updates Parcel Service | |
DELETE /shop1/api.php/v2/parcel_services/ | Delete Parcel Service | |
GET /shop1/api.php/v2/parcel_services/ | 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//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/ | Update Order | |
DELETE /shop1/api.php/v2/orders/ | Delete Order | |
GET /shop1/api.php/v2/orders/ | Get Order (Single) | |
GET /shop1/api.php/v2/orders//history | Get Order History (Multiple) | |
GET /shop1/api.php/v2/orders//history/ | Get Order History (Single) | |
POST /shop1/api.php/v2/orders//items | Create Order Item | |
GET /shop1/api.php/v2/orders//items | Get Order Items (Multiple) | |
PUT /shop1/api.php/v2/orders//items/ | Update Order Item | |
DELETE /shop1/api.php/v2/orders//items/ | Delete Order Item | |
GET /shop1/api.php/v2/orders//items/ | Get Order Item (Single) | |
POST /shop1/api.php/v2/orders//items//attributes | Create Order Item Attribute | |
PUT /shop1/api.php/v2/orders//items//attributes//Property | Update Order Item Attribute/Property | |
DELETE /shop1/api.php/v2/orders//items//attributes//Property | Delete Order Item Attribute/Property | |
GET /shop1/api.php/v2/orders//items//attributes//Property | Get Order Item Attribute/Property (Single) | |
GET /shop1/api.php/v2/orders//items//attributes/Property | Get Order Item Attributes/Properties (Multiple) | |
GET /shop1/api.php/v2/orders//payment_details | Get Order Payment Details | |
POST /shop1/api.php/v2/orders//totals | Create Order Total | |
GET /shop1/api.php/v2/orders//totals | Get Order Totals (Multiple) | |
PUT /shop1/api.php/v2/orders//totals/ | Update Order Total | |
DELETE /shop1/api.php/v2/orders//totals/ | Delete Order Total | |
GET /shop1/api.php/v2/orders//totals/ | Get Order Total | |
POST /shop1/api.php/v2/orders//tracking_code | Create Order Tracking Code (deprecated) | |
GET /shop1/api.php/v2/orders//tracking_code | Get Order Tracking Codes (Multiple) (deprecated) | |
POST /shop1/api.php/v2/orders//tracking_codes | Create Order Tracking Code | |
GET /shop1/api.php/v2/orders//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/ | 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/ | Update Product Prices | |
DELETE /shop1/api.php/v2/product_prices/ | Delete Product Prices | |
GET /shop1/api.php/v2/product_prices/ | Get Product Prices | |
GET /shop1/api.php/v2/product_prices//customer_groups// | Get Graduated Product Price | |
Quantity Units
HTTP Request | Description | Status |
---|---|---|
PATCH /shop1/api.php/v2/quantity_units/ | 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/ | Delete Quantity Units | |
GET /shop1/api.php/v2/quantity_units/ | 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/ | Update Product | |
GET /shop1/api.php/v2/products/ | Get Products | |
POST /shop1/api.php/v2/products//links | Create Product Link | |
PUT /shop1/api.php/v2/products//links | Update Product Link | |
DELETE /shop1/api.php/v2/products//links | Delete Product Link | |
GET /shop1/api.php/v2/products//links | Get Product Links | |
PUT /shop1/api.php/v2/products//product_prices | Update Product Prices | |
GET /shop1/api.php/v2/products//product_prices | Get Product Prices | |
GET /shop1/api.php/v2/products//product_prices/customer_groups// | Get Graduated Product Price | |
DELETE /shop1/api.php/v2/products/ | 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/ | Update Review | |
DELETE /shop1/api.php/v2/reviews/ | Delete Review | |
GET /shop1/api.php/v2/reviews/ | 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/ | Removes Special Offers | |
PUT /shop1/api.php/v2/special_offers/ | Updates Special Offers | |
GET /shop1/api.php/v2/special_offers/ | 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/ | Delete Tracking Code (deprecated) | |
GET /shop1/api.php/v2/tracking_code/ | 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/ | Delete Tracking Code | |
GET /shop1/api.php/v2/tracking_codes/ | Get Tracking Code (Single) | |
Vpe
HTTP Request | Description | Status |
---|---|---|
PATCH /shop1/api.php/v2/vpe/ | Updates VPE | |
POST /shop1/api.php/v2/vpe | Create VPE | |
DELETE /shop1/api.php/v2/vpe/ | Delete VPE | |
GET /shop1/api.php/v2/vpe/ | 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/ | Update Withdrawal | |
DELETE /shop1/api.php/v2/withdrawals/ | Delete Withdrawal | |
GET /shop1/api.php/v2/withdrawals/ | Get Withdrawal (Single) | |
Zones
HTTP Request | Description | Status |
---|---|---|
GET /shop1/api.php/v2/zones/ | Get Zones | |