Address Formats

Operation HTTP Request Description
get
GET /shop1/api.php/v2/address_formats
Get Address Formats

Addresses

Operation HTTP Request Description
post
POST /shop1/api.php/v2/addresses
Create Address
delete
DELETE /shop1/api.php/v2/addresses/{address_id}
Delete Address
get
GET /shop1/api.php/v2/addresses/{address_id}
Get Address (Single)
get
GET /shop1/api.php/v2/addresses
Get Addresses (Multiple)
put
PUT /shop1/api.php/v2/addresses/{address_id}
Update Address

Attachments

Operation HTTP Request Description
post
POST /shop1/api.php/v2/attachments
Upload Attachment

Cache

Operation HTTP Request Description
delete
DELETE /shop1/api.php/v2/cache
Clear Shop Cache

Categories

Operation HTTP Request Description
post
POST /shop1/api.php/v2/categories
Create Categories
delete
DELETE /shop1/api.php/v2/categories/{category_ids}
Delete Categories
get
GET /shop1/api.php/v2/categories
Get Categories (Multiple)
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
post
POST /shop1/api.php/v2/categories/search
Search Categories
put
PUT /shop1/api.php/v2/categories/{category_id}
Update Category
put
PUT /shop1/api.php/v2/categories
Update Category (Multiple)

Category Icons

Operation HTTP Request Description
delete
DELETE /shop1/api.php/v2/category_icons
Delete Category Icon
get
GET /shop1/api.php/v2/category_icons
Get Category Icons
put
PUT /shop1/api.php/v2/category_icons
Rename Icon File
post
POST /shop1/api.php/v2/category_icons
Upload Category Icon

Category Images

Operation HTTP Request Description
delete
DELETE /shop1/api.php/v2/category_images
Delete Category Image
get
GET /shop1/api.php/v2/category_images
Get Category Images
put
PUT /shop1/api.php/v2/category_images
Rename Image File
post
POST /shop1/api.php/v2/category_images
Upload Category Image

Countries

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

Cronjobs

Operation HTTP Request Description
post
POST /shop1/api.php/v2/cronjobs/image_processing
Set ImageProcessing Trigger

Customer Groups

Operation HTTP Request Description
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
patch
PATCH /shop1/api.php/v2/customer_groups/{customer_group_id}
Updates CustomerGroup entity

Customers

Operation HTTP Request Description
post
POST /shop1/api.php/v2/customers
Create Customers
delete
DELETE /shop1/api.php/v2/customers/{customer_ids}
Delete Customers
get
GET /shop1/api.php/v2/customers/{customer_id}
Get Customer (Single)
get
GET /shop1/api.php/v2/customers
Get Customers
post
POST /shop1/api.php/v2/customers/search
Search Customers
put
PUT /shop1/api.php/v2/customers/{customer_id}
Update Customer
put
PUT /shop1/api.php/v2/customers
Update Customers (Multiple)

Emails

Operation HTTP Request Description
delete
DELETE /shop1/api.php/v2/emails/{email_id}
Delete Email
get
GET /shop1/api.php/v2/emails/{email_id}
Get Emails
put
PUT /shop1/api.php/v2/emails
Queue Email
post
POST /shop1/api.php/v2/emails/{email_id}
Send Email

Manufacturers

Operation HTTP Request Description
post
POST /shop1/api.php/v2/manufacturers
Create Manufacturers
delete
DELETE /shop1/api.php/v2/manufacturers/{manufacturer_id}
Delete Manufacturers
get
GET /shop1/api.php/v2/manufacturers/{manufacturer_id}
Get Manufacturers
get
GET /shop1/api.php/v2/manufacturers
Get Manufacturers (Multiple)
post
POST /shop1/api.php/v2/manufacturers/search
Search Manufacturers
patch
PATCH /shop1/api.php/v2/manufacturers/{manufacturer_id}
Updates Manufacturers

Order Statuses

Operation HTTP Request Description
post
POST /shop1/api.php/v2/order_statuses
Create Order Status
delete
DELETE /shop1/api.php/v2/order_statuses/{order_status_id}
Delete Order Status
get
GET /shop1/api.php/v2/order_statuses
Get order statuses (Multiple)
get
GET /shop1/api.php/v2/order_statuses/{order_status_id}
Get order statuses (Single)
put
PUT /shop1/api.php/v2/order_statuses/{order_status_id}
Update Order Status

Orders History

Operation HTTP Request Description
get
GET /shop1/api.php/v2/orders_history/{order_id}
Get Order History (Single)

Orders

Operation HTTP Request Description
post
POST /shop1/api.php/v2/orders
Create Order
post
POST /shop1/api.php/v2/orders/{order_id}/items
Create Order Item
post
POST /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes
Create Order Item Attribute
post
POST /shop1/api.php/v2/orders/{order_id}/totals
Create Order Total
post
POST /shop1/api.php/v2/orders/{order_id}/tracking_codes
Create Order Tracking Code
post
POST /shop1/api.php/v2/orders/{order_id}/tracking_code
Create Order Tracking Code (deprecated)
delete
DELETE /shop1/api.php/v2/orders/{order_id}
Delete Order
delete
DELETE /shop1/api.php/v2/orders/{order_id}/items/{item_id}
Delete Order Item
delete
DELETE /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/{attribute_id}/Property
Delete Order Item Attribute/Property
delete
DELETE /shop1/api.php/v2/orders/{order_id}/totals/{total_id}
Delete Order Total
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)
get
GET /shop1/api.php/v2/orders/{order_id}/items/{item_id}
Get Order Item (Single)
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}/items
Get Order Items (Multiple)
get
GET /shop1/api.php/v2/orders/{order_id}/payment_details
Get Order Payment Details
get
GET /shop1/api.php/v2/orders/{order_id}/totals/{totals_id}
Get Order Total
get
GET /shop1/api.php/v2/orders/{order_id}/totals
Get Order Totals (Multiple)
get
GET /shop1/api.php/v2/orders/{order_id}/tracking_codes
Get Order Tracking Codes (Multiple)
get
GET /shop1/api.php/v2/orders/{order_id}/tracking_code
Get Order Tracking Codes (Multiple) (deprecated)
get
GET /shop1/api.php/v2/orders
Get Orders (Multiple)
post
POST /shop1/api.php/v2/orders/search
Search Orders
put
PUT /shop1/api.php/v2/orders/{order_id}
Update Order
put
PUT /shop1/api.php/v2/orders/{order_id}/items/{item_id}
Update Order Item
put
PUT /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/{attribute_id}/Property
Update Order Item Attribute/Property
patch
PATCH /shop1/api.php/v2/orders/{order_id}/status
Update Order Status
put
PUT /shop1/api.php/v2/orders/{order_id}/totals/{total_id}
Update Order Total

Parcel Services

Operation HTTP Request Description
post
POST /shop1/api.php/v2/parcel_services
Create 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)
get
GET /shop1/api.php/v2/parcel_services
Get Parcel Services (Multiple)
post
POST /shop1/api.php/v2/parcel_services/search
Search Parcel Services
put
PUT /shop1/api.php/v2/parcel_services/{parcel_service_id}
Updates Parcel Service

Payment Details

Operation HTTP Request Description
get
GET /shop1/api.php/v2/payment_details/{order_id}
Get Payment Details

Product Images

Operation HTTP Request Description
delete
DELETE /shop1/api.php/v2/product_images
Delete Product Image
get
GET /shop1/api.php/v2/product_images
Get Product Images
put
PUT /shop1/api.php/v2/product_images
Rename Image File
post
POST /shop1/api.php/v2/product_images
Upload Product Image

Product Prices

Operation HTTP Request Description
delete
DELETE /shop1/api.php/v2/product_prices/{product_id}
Delete Product Prices
get
GET /shop1/api.php/v2/product_prices/{product_id}/customer_groups/{customer_group_id}/{quantity}
Get Graduated Product Price
get
GET /shop1/api.php/v2/product_prices/{product_id}
Get Product Prices
put
PUT /shop1/api.php/v2/product_prices/{product_id}
Update Product Prices

Products

Operation HTTP Request Description
post
POST /shop1/api.php/v2/products/{product_id}/links
Create Product Link
post
POST /shop1/api.php/v2/products
Create Products
delete
DELETE /shop1/api.php/v2/products/{product_id}/links
Delete Product Link
delete
DELETE /shop1/api.php/v2/products/{product_ids}
Delete Products (Multiple)
get
GET /shop1/api.php/v2/products/{product_id}/product_prices/customer_groups/{customer_group_id}/{quantity}
Get Graduated Product Price
get
GET /shop1/api.php/v2/products/{product_id}/links
Get Product Links
get
GET /shop1/api.php/v2/products/{product_id}/product_prices
Get Product Prices
get
GET /shop1/api.php/v2/products/{product_id}
Get Products
get
GET /shop1/api.php/v2/products
Get Products
post
POST /shop1/api.php/v2/products/search
Search Products
put
PUT /shop1/api.php/v2/products/{product_id}
Update Product
put
PUT /shop1/api.php/v2/products/{product_id}/links
Update Product Link
put
PUT /shop1/api.php/v2/products/{product_id}/product_prices
Update Product Prices
put
PUT /shop1/api.php/v2/products
Update Products (Multiple)

Quantity Units

Operation HTTP Request Description
post
POST /shop1/api.php/v2/quantity_units
Create Quantity Units
delete
DELETE /shop1/api.php/v2/quantity_units/{quantity_unit_id}
Delete Quantity Units
get
GET /shop1/api.php/v2/quantity_units
Get Quantity Units (Multiple)
get
GET /shop1/api.php/v2/quantity_units/{quantity_unit_id}
Get Quantity Units (Single)
patch
PATCH /shop1/api.php/v2/quantity_units/{quantity_unit_id}
Updates Quantity Units

Reviews

Operation HTTP Request Description
post
POST /shop1/api.php/v2/reviews
Create Review
delete
DELETE /shop1/api.php/v2/reviews/{review_id}
Delete Review
get
GET /shop1/api.php/v2/reviews/{review_id}
Get Review (Single)
get
GET /shop1/api.php/v2/reviews
Get Reviews (Multiple)
put
PUT /shop1/api.php/v2/reviews/{review_id}
Update Review

Shop Information

Operation HTTP Request Description
get
GET /shop1/api.php/v2/shop_information
Get Shop Information

Special Offers

Operation HTTP Request Description
post
POST /shop1/api.php/v2/special_offers
Create Special Offers
get
GET /shop1/api.php/v2/special_offers/{special_offer_id}
Get 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
post
POST /shop1/api.php/v2/special_offers/search
Search Special Offer
put
PUT /shop1/api.php/v2/special_offers/{special_offer_id}
Updates Special Offers

Tax

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

Tracking Code

Operation HTTP Request Description
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)
get
GET /shop1/api.php/v2/tracking_code
Get Tracking Codes (Multiple) (deprecated)

Tracking Codes

Operation HTTP Request Description
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)
get
GET /shop1/api.php/v2/tracking_codes
Get Tracking Codes (Multiple)

Vpe

Operation HTTP Request Description
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)
patch
PATCH /shop1/api.php/v2/vpe/{vpe_id}
Updates VPE

Withdrawal

Operation HTTP Request Description
post
POST /shop1/api.php/v2/withdrawals
Create Withdrawal
delete
DELETE /shop1/api.php/v2/withdrawals/{withdrawal_id}
Delete Withdrawal
get
GET /shop1/api.php/v2/withdrawals/{withdrawal_id}
Get Withdrawal (Single)
get
GET /shop1/api.php/v2/withdrawals
Get Withdrawals (Multiple)
put
PUT /shop1/api.php/v2/withdrawals/{withdrawal_id}
Update Withdrawal

Zones

Operation HTTP Request Description
get
GET /shop1/api.php/v2/zones/{zone_id}
Get Zones