| Operation | HTTP Request | Description |
|---|---|---|
| get |
GET /shop1/api.php/v2/address_formats |
Get Address Formats |
| Operation | HTTP Request | Description |
|---|---|---|
| post |
POST /shop1/api.php/v2/addresses |
Create Address |
| get |
GET /shop1/api.php/v2/addresses |
Get Addresses (Multiple) |
| put |
PUT /shop1/api.php/v2/addresses/{address_id}
|
Update Address |
| delete |
DELETE /shop1/api.php/v2/addresses/{address_id}
|
Delete Address |
| get |
GET /shop1/api.php/v2/addresses/{address_id}
|
Get Address (Single) |
| Operation | HTTP Request | Description |
|---|---|---|
| post |
POST /shop1/api.php/v2/attachments |
Upload Attachment |
| Operation | HTTP Request | Description |
|---|---|---|
| delete |
DELETE /shop1/api.php/v2/cache |
Clear Shop Cache |
| Operation | HTTP Request | Description |
|---|---|---|
| post |
POST /shop1/api.php/v2/categories |
Create Categories |
| put |
PUT /shop1/api.php/v2/categories |
Update Category (Multiple) |
| get |
GET /shop1/api.php/v2/categories |
Get Categories (Multiple) |
| put |
PUT /shop1/api.php/v2/categories/{category_id}
|
Update Category |
| get |
GET /shop1/api.php/v2/categories/{category_id}
|
Get Categories (Single) |
| get |
GET /shop1/api.php/v2/categories/{category_id}/children
|
Get Category Children |
| get |
GET /shop1/api.php/v2/categories/{category_id}/products
|
Get Category Products |
| delete |
DELETE /shop1/api.php/v2/categories/{category_ids}
|
Delete Categories |
| post |
POST /shop1/api.php/v2/categories/search |
Search Categories |
| Operation | HTTP Request | Description |
|---|---|---|
| put |
PUT /shop1/api.php/v2/category_icons |
Rename Icon File |
| post |
POST /shop1/api.php/v2/category_icons |
Upload Category Icon |
| delete |
DELETE /shop1/api.php/v2/category_icons |
Delete Category Icon |
| get |
GET /shop1/api.php/v2/category_icons |
Get Category Icons |
| Operation | HTTP Request | Description |
|---|---|---|
| put |
PUT /shop1/api.php/v2/category_images |
Rename Image File |
| post |
POST /shop1/api.php/v2/category_images |
Upload Category Image |
| delete |
DELETE /shop1/api.php/v2/category_images |
Delete Category Image |
| get |
GET /shop1/api.php/v2/category_images |
Get Category Images |
| Operation | HTTP Request | Description |
|---|---|---|
| get |
GET /shop1/api.php/v2/countries/{country_id}
|
Get Countries (Single) |
| get |
GET /shop1/api.php/v2/countries/{country_id}/zones
|
Get Countries Zones |
| Operation | HTTP Request | Description |
|---|---|---|
| post |
POST /shop1/api.php/v2/cronjobs/image_processing |
Set ImageProcessing Trigger |
| Operation | HTTP Request | Description |
|---|---|---|
| patch |
PATCH /shop1/api.php/v2/customer_groups/{customer_group_id}
|
Updates CustomerGroup entity |
| post |
POST /shop1/api.php/v2/customer_groups |
Create CustomerGroups |
| delete |
DELETE /shop1/api.php/v2/customer_groups/{customer_group_id}
|
Delete Customer Groups |
| get |
GET /shop1/api.php/v2/customer_groups/{customer_group_id}
|
Get customer groups |
| Operation | HTTP Request | Description |
|---|---|---|
| post |
POST /shop1/api.php/v2/customers |
Create Customers |
| put |
PUT /shop1/api.php/v2/customers |
Update Customers (Multiple) |
| get |
GET /shop1/api.php/v2/customers |
Get Customers |
| put |
PUT /shop1/api.php/v2/customers/{customer_id}
|
Update Customer |
| get |
GET /shop1/api.php/v2/customers/{customer_id}
|
Get Customer (Single) |
| delete |
DELETE /shop1/api.php/v2/customers/{customer_ids}
|
Delete Customers |
| post |
POST /shop1/api.php/v2/customers/search |
Search Customers |
| Operation | HTTP Request | Description |
|---|---|---|
| put |
PUT /shop1/api.php/v2/emails |
Queue Email |
| post |
POST /shop1/api.php/v2/emails/{email_id}
|
Send Email |
| delete |
DELETE /shop1/api.php/v2/emails/{email_id}
|
Delete Email |
| get |
GET /shop1/api.php/v2/emails/{email_id}
|
Get Emails |
| Operation | HTTP Request | Description |
|---|---|---|
| patch |
PATCH /shop1/api.php/v2/manufacturers/{manufacturer_id}
|
Updates Manufacturers |
| post |
POST /shop1/api.php/v2/manufacturers |
Create Manufacturers |
| get |
GET /shop1/api.php/v2/manufacturers |
Get Manufacturers (Multiple) |
| delete |
DELETE /shop1/api.php/v2/manufacturers/{manufacturer_id}
|
Delete Manufacturers |
| get |
GET /shop1/api.php/v2/manufacturers/{manufacturer_id}
|
Get Manufacturers |
| post |
POST /shop1/api.php/v2/manufacturers/search |
Search Manufacturers |
| Operation | HTTP Request | Description |
|---|---|---|
| post |
POST /shop1/api.php/v2/order_statuses |
Create Order Status |
| get |
GET /shop1/api.php/v2/order_statuses |
Get order statuses (Multiple) |
| put |
PUT /shop1/api.php/v2/order_statuses/{order_status_id}
|
Update Order Status |
| delete |
DELETE /shop1/api.php/v2/order_statuses/{order_status_id}
|
Delete Order Status |
| get |
GET /shop1/api.php/v2/order_statuses/{order_status_id}
|
Get order statuses (Single) |
| Operation | HTTP Request | Description |
|---|---|---|
| patch |
PATCH /shop1/api.php/v2/orders/{order_id}/status
|
Update Order Status |
| post |
POST /shop1/api.php/v2/orders |
Create Order |
| get |
GET /shop1/api.php/v2/orders |
Get Orders (Multiple) |
| put |
PUT /shop1/api.php/v2/orders/{order_id}
|
Update Order |
| delete |
DELETE /shop1/api.php/v2/orders/{order_id}
|
Delete Order |
| get |
GET /shop1/api.php/v2/orders/{order_id}
|
Get Order (Single) |
| get |
GET /shop1/api.php/v2/orders/{order_id}/history
|
Get Order History (Multiple) |
| get |
GET /shop1/api.php/v2/orders/{order_id}/history/{history_id}
|
Get Order History (Single) |
| post |
POST /shop1/api.php/v2/orders/{order_id}/items
|
Create Order Item |
| get |
GET /shop1/api.php/v2/orders/{order_id}/items
|
Get Order Items (Multiple) |
| put |
PUT /shop1/api.php/v2/orders/{order_id}/items/{item_id}
|
Update Order Item |
| delete |
DELETE /shop1/api.php/v2/orders/{order_id}/items/{item_id}
|
Delete Order Item |
| get |
GET /shop1/api.php/v2/orders/{order_id}/items/{item_id}
|
Get Order Item (Single) |
| post |
POST /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes
|
Create Order Item Attribute |
| put |
PUT /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/{attribute_id}/Property
|
Update Order Item Attribute/Property |
| delete |
DELETE /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/{attribute_id}/Property
|
Delete Order Item Attribute/Property |
| get |
GET /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/{attribute_id}/Property
|
Get Order Item Attribute/Property (Single) |
| get |
GET /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/Property
|
Get Order Item Attributes/Properties (Multiple) |
| get |
GET /shop1/api.php/v2/orders/{order_id}/payment_details
|
Get Order Payment Details |
| post |
POST /shop1/api.php/v2/orders/{order_id}/totals
|
Create Order Total |
| get |
GET /shop1/api.php/v2/orders/{order_id}/totals
|
Get Order Totals (Multiple) |
| put |
PUT /shop1/api.php/v2/orders/{order_id}/totals/{total_id}
|
Update Order Total |
| delete |
DELETE /shop1/api.php/v2/orders/{order_id}/totals/{total_id}
|
Delete Order Total |
| get |
GET /shop1/api.php/v2/orders/{order_id}/totals/{totals_id}
|
Get Order Total |
| post |
POST /shop1/api.php/v2/orders/{order_id}/tracking_code
|
Create Order Tracking Code (deprecated) |
| get |
GET /shop1/api.php/v2/orders/{order_id}/tracking_code
|
Get Order Tracking Codes (Multiple) (deprecated) |
| post |
POST /shop1/api.php/v2/orders/{order_id}/tracking_codes
|
Create Order Tracking Code |
| get |
GET /shop1/api.php/v2/orders/{order_id}/tracking_codes
|
Get Order Tracking Codes (Multiple) |
| post |
POST /shop1/api.php/v2/orders/search |
Search Orders |
| Operation | HTTP Request | Description |
|---|---|---|
| get |
GET /shop1/api.php/v2/orders_history/{order_id}
|
Get Order History (Single) |
| Operation | HTTP Request | Description |
|---|---|---|
| post |
POST /shop1/api.php/v2/parcel_services |
Create Parcel Service |
| get |
GET /shop1/api.php/v2/parcel_services |
Get Parcel Services (Multiple) |
| put |
PUT /shop1/api.php/v2/parcel_services/{parcel_service_id}
|
Updates Parcel Service |
| delete |
DELETE /shop1/api.php/v2/parcel_services/{parcel_service_id}
|
Delete Parcel Service |
| get |
GET /shop1/api.php/v2/parcel_services/{parcel_service_id}
|
Get Parcel Service (Single) |
| post |
POST /shop1/api.php/v2/parcel_services/search |
Search Parcel Services |
| Operation | HTTP Request | Description |
|---|---|---|
| get |
GET /shop1/api.php/v2/payment_details/{order_id}
|
Get Payment Details |
| Operation | HTTP Request | Description |
|---|---|---|
| put |
PUT /shop1/api.php/v2/product_images |
Rename Image File |
| post |
POST /shop1/api.php/v2/product_images |
Upload Product Image |
| delete |
DELETE /shop1/api.php/v2/product_images |
Delete Product Image |
| get |
GET /shop1/api.php/v2/product_images |
Get Product Images |
| Operation | HTTP Request | Description |
|---|---|---|
| put |
PUT /shop1/api.php/v2/product_prices/{product_id}
|
Update Product Prices |
| delete |
DELETE /shop1/api.php/v2/product_prices/{product_id}
|
Delete Product Prices |
| get |
GET /shop1/api.php/v2/product_prices/{product_id}
|
Get Product Prices |
| get |
GET /shop1/api.php/v2/product_prices/{product_id}/customer_groups/{customer_group_id}/{quantity}
|
Get Graduated Product Price |
| Operation | HTTP Request | Description |
|---|---|---|
| post |
POST /shop1/api.php/v2/products |
Create Products |
| put |
PUT /shop1/api.php/v2/products |
Update Products (Multiple) |
| get |
GET /shop1/api.php/v2/products |
Get Products |
| put |
PUT /shop1/api.php/v2/products/{product_id}
|
Update Product |
| get |
GET /shop1/api.php/v2/products/{product_id}
|
Get Products |
| post |
POST /shop1/api.php/v2/products/{product_id}/links
|
Create Product Link |
| put |
PUT /shop1/api.php/v2/products/{product_id}/links
|
Update Product Link |
| delete |
DELETE /shop1/api.php/v2/products/{product_id}/links
|
Delete Product Link |
| get |
GET /shop1/api.php/v2/products/{product_id}/links
|
Get Product Links |
| put |
PUT /shop1/api.php/v2/products/{product_id}/product_prices
|
Update Product Prices |
| get |
GET /shop1/api.php/v2/products/{product_id}/product_prices
|
Get Product Prices |
| get |
GET /shop1/api.php/v2/products/{product_id}/product_prices/customer_groups/{customer_group_id}/{quantity}
|
Get Graduated Product Price |
| delete |
DELETE /shop1/api.php/v2/products/{product_ids}
|
Delete Products (Multiple) |
| post |
POST /shop1/api.php/v2/products/search |
Search Products |
| Operation | HTTP Request | Description |
|---|---|---|
| patch |
PATCH /shop1/api.php/v2/quantity_units/{quantity_unit_id}
|
Updates Quantity Units |
| post |
POST /shop1/api.php/v2/quantity_units |
Create Quantity Units |
| get |
GET /shop1/api.php/v2/quantity_units |
Get Quantity Units (Multiple) |
| delete |
DELETE /shop1/api.php/v2/quantity_units/{quantity_unit_id}
|
Delete Quantity Units |
| get |
GET /shop1/api.php/v2/quantity_units/{quantity_unit_id}
|
Get Quantity Units (Single) |
| Operation | HTTP Request | Description |
|---|---|---|
| post |
POST /shop1/api.php/v2/reviews |
Create Review |
| get |
GET /shop1/api.php/v2/reviews |
Get Reviews (Multiple) |
| put |
PUT /shop1/api.php/v2/reviews/{review_id}
|
Update Review |
| delete |
DELETE /shop1/api.php/v2/reviews/{review_id}
|
Delete Review |
| get |
GET /shop1/api.php/v2/reviews/{review_id}
|
Get Review (Single) |
| Operation | HTTP Request | Description |
|---|---|---|
| get |
GET /shop1/api.php/v2/shop_information |
Get Shop Information |
| Operation | HTTP Request | Description |
|---|---|---|
| post |
POST /shop1/api.php/v2/special_offers |
Create Special Offers |
| get |
GET /shop1/api.php/v2/special_offers |
Get Special Offers (Multiple) |
| delete |
DELETE /shop1/api.php/v2/special_offers/{special_offer_id}
|
Removes Special Offers |
| put |
PUT /shop1/api.php/v2/special_offers/{special_offer_id}
|
Updates Special Offers |
| get |
GET /shop1/api.php/v2/special_offers/{special_offer_id}
|
Get Special Offers |
| post |
POST /shop1/api.php/v2/special_offers/search |
Search Special Offer |
| Operation | HTTP Request | Description |
|---|---|---|
| get |
GET /shop1/api.php/v2/tax_classes |
Get Tax Classes |
| get |
GET /shop1/api.php/v2/tax_rates |
Get Tax Rates |
| get |
GET /shop1/api.php/v2/tax_zones |
Get Tax Zones |
| Operation | HTTP Request | Description |
|---|---|---|
| get |
GET /shop1/api.php/v2/tracking_code |
Get Tracking Codes (Multiple) (deprecated) |
| delete |
DELETE /shop1/api.php/v2/tracking_code/{tracking_code_id}
|
Delete Tracking Code (deprecated) |
| get |
GET /shop1/api.php/v2/tracking_code/{tracking_code_id}
|
Get Tracking Code (Single) (deprecated) |
| Operation | HTTP Request | Description |
|---|---|---|
| get |
GET /shop1/api.php/v2/tracking_codes |
Get Tracking Codes (Multiple) |
| delete |
DELETE /shop1/api.php/v2/tracking_codes/{tracking_code_id}
|
Delete Tracking Code |
| get |
GET /shop1/api.php/v2/tracking_codes/{tracking_code_id}
|
Get Tracking Code (Single) |
| Operation | HTTP Request | Description |
|---|---|---|
| patch |
PATCH /shop1/api.php/v2/vpe/{vpe_id}
|
Updates VPE |
| post |
POST /shop1/api.php/v2/vpe |
Create VPE |
| delete |
DELETE /shop1/api.php/v2/vpe/{vpe_id}
|
Delete VPE |
| get |
GET /shop1/api.php/v2/vpe/{vpe_id}
|
Get VPE (Single) |
| Operation | HTTP Request | Description |
|---|---|---|
| post |
POST /shop1/api.php/v2/withdrawals |
Create Withdrawal |
| get |
GET /shop1/api.php/v2/withdrawals |
Get Withdrawals (Multiple) |
| put |
PUT /shop1/api.php/v2/withdrawals/{withdrawal_id}
|
Update Withdrawal |
| delete |
DELETE /shop1/api.php/v2/withdrawals/{withdrawal_id}
|
Delete Withdrawal |
| get |
GET /shop1/api.php/v2/withdrawals/{withdrawal_id}
|
Get Withdrawal (Single) |
| Operation | HTTP Request | Description |
|---|---|---|
| get |
GET /shop1/api.php/v2/zones/{zone_id}
|
Get Zones |