Jump to Content

v1.0

API Reference

v1.0API Reference

All

Pages

Start typing to search…

Countries

/countries
- List countriesget
/countries/{id}
- Get a specific countryget

Payment Methods

/payment-methods
- List external payment methodsget

Business

/business
- Retrieve business detailsget

Business Features

/business/features
- List business featuresget
/business/features/change-status
- Change business feature statuspost

Custom Fields

/custom-fields
- List custom fieldsget
- Create a custom fieldpost
/custom-fields/count
- Get total custom field countget
/custom-fields/{id}

Webhooks

/webhooks
- List webhooksget
- Create a webhookpost
/webhooks/count
- Count webhooksget
/webhooks/{id}
/webhooks/{id}/verify
- Verify a webhookpost

Events

/events
- Get all eventsget
/events/count
- Get total event countget
/events/{id}
- Get an event by IDget

App Data Management

/app
- Return an app IDget
/app/data

Incomplete Orders

/incomplete-orders
- List incomplete ordersget
/incomplete-orders/{id}
- Get an incomplete order by IDget
/incomplete-orders/count
- Get total incomplete order countget

Orders

/orders
- List ordersget
- Create a new orderpost
/orders/search
- Search for ordersget
/orders/count
- Get order countget
/orders/{id}
- Get an order by IDget
- Delete an orderdel

Orders Status, Comments, Pre-orders

/orders/{id}/status
- Update an order's statuspost
/orders/{id}/dispatch-pre-order
- Request a pre-order be dispatchedpost
/orders/{id}/comments
- Create an order admin commentpost
/orders/{id}/comments/{comment_id}
- Delete an order admin commentdel

Order Statuses

/order-statuses
- List order statusesget
- Create an order statuspost
/order-statuses/{id}
- Delete an order statusdel

Refunds

/orders/{order_id}/refunds
- Create a refund for an orderpost

Customers

/customers
- List customersget
- Create a new customerpost
/customers/count
- Get total customer countget
/customers/{id}
- Get a specific customerget

Newsletter subscribers

/newsletter-subscribers
- List newsletter subscribersget
/newsletter-subscribers/{id}
- Get a specific newsletter subscriberget

Product Reviews

/products/{product_id}/reviews
- List product reviewsget
- Create a product reviewpost
/products/{product_id}/reviews/{id}
- Update a product reviewput
- Delete a product reviewdel

Wishlists

/wishlists
- List wishlistsget
- Create a wishlistpost
/wishlists/count
- Count wishlistsget
/wishlists/{id}
- Get a specific wishlistget
- Update a wishlistput
/wishlists/{id}/modify
- Modify a wishlistpost

Brands

/brands
- List active brandsget
- Create a new brandpost
/brands/count
- Get total brand countget
/brands/{id}

Categories

/categories
- List categoriesget
- Create a new categorypost
/categories/count
- Get total category countget
/categories/{id}

Filter Groups

/filter-groups
- List filter groupsget
- Create a new filter grouppost
/filter-groups/count
- Get total filter group countget
/filter-groups/{id}

Digital Files

/digital-files
- List digital filesget
- Create a new digital filepost
/digital-files/count
- Get total digital file countget
/digital-files/{id}

Choice Sets

/choice-sets
- List choice setsget
- Create a choice setpost
/choice-sets/{id}

Choice Set Values

/choice-set-values
- Create a choice set valuepost
/choice-set-values/{id}
- Update a choice set valueput
- Delete a choice set valuedel

Products

/products
- List productsget
- Create a new productpost
/products/search
- Search productsget
/products/count
- Get product countget
/products/{id}

Product Customisation Fields

/products/{product_id}/customization-fields
- List product customisation fieldsget
- Create a product customisation fieldpost
/products/{product_id}/customization-fields/{id}
- Update a product customisation fieldput
- Delete a product customisation fielddel

Product Extras

/products/{product_id}/extras
- List product extrasget
- Create a product extrapost
/products/{product_id}/extras/{id}
- Update a product extraput
- Delete a product extradel

Product Images

/products/{product_id}/images
- List product imagesget
- Create a product imagepost
/products/{product_id}/images/{id}
- Update a product imageput
- Delete a product imagedel

Product Options

/products/{product_id}/options
- List product optionsget
- Create a product optionpost
/products/{product_id}/options/{id}

Product Option Values

/products/{product_id}/option-values
- Create a product option valuepost
/products/{product_id}/option-values/{id}
- Update a product option valueput
- Delete a product option valuedel

Product Variations

/products/{product_id}/variations
- List product variationsget
- Create a new product variationpost
/products/{product_id}/variations/{id}

Product Choices

/products/{product_id}/choices
- List product choicesget
- Assign a choice to a productpost
/products/{product_id}/choices/{id}

Stock

/stock
- Retrieve stock quantityget
- Update stock quantitypost
/stock/return
- Return stock for cancelled orderspost

Stock Requests

/stock-requests
- List stock requestsget

Product Prices

/products/prices
- Update product pricespost

Vouchers

/vouchers
- List vouchersget
- Create a new voucherpost
/vouchers/count
- Get total voucher countget
/vouchers/{id}

Gift Cards

/gift-vouchers
- List gift cardsget
- Create a gift cardpost
/gift-vouchers/count
- Get total gift card countget
/gift-vouchers/{id}

Offers

/offers
- List offersget
- Create a new offerpost
/offers/count
- Get total offer countget
/offers/{id}

Sales

/sales
- List salesget
- Create a salepost
/sales/count
- Get total sales countget
/sales/{id}

Collect Locations

/collect-locations
- List collect locationsget
/collect-locations/count
- Get total collect location countget
/collect-locations/{id}
- Get a specific collect locationget

Business Nexus

/nexuses
- List business nexus itemsget
- Create a new business nexus itempost
/nexuses/{id}
- Update a business nexus itemput
- Delete a business nexus itemdel

Shipping Zones

/shipping-zones
- List shipping zonesget
- Create a new shipping zonepost
/shipping-zones/count
- Get total shipping zone countget
/shipping-zones/{country-id}

Shipping Rates

/shipping-rates
- List shipping ratesget
- Create a new shipping ratepost
/shipping-rates/{id}

ShopWired Payments Payouts

/shopwired-payments/payouts
- List payoutsget
/shopwired-payments/payouts/{payout_id}
- Get a specific payoutget
/shopwired-payments/payouts/count
- Get total payout countget

ShopWired Payments Disputes

/shopwired-payments/disputes
- List disputesget
/shopwired-payments/disputes/{dispute_id}
- Get a specific disputeget
/shopwired-payments/disputes/count
- Get total dispute countget

Trade Customer Product Prices

/trade-customer-product-prices
- List trade customer product pricesget
- Create a new trade customer product pricepost
/trade-customer-product-prices/count
- Get total trade customer product price countget
/trade-customer-product-prices/{id}
/trade-customer-product-prices/bulk
- Bulk create or remove trade customer product pricespost

Product Bulk Prices

/products/{id}/bulk-prices
- List bulk prices for a productget
- Create a bulk price for a productpost
/products/{product_id}/bulk-prices/{id}

Trade Groups

/trade-groups
- List trade pricing bandsget
- Create a trade pricing bandpost
/trade-groups/{id}

Blog Categories

/blog-categories
- List blog categoriesget
- Create a new blog categorypost
/blog-categories/count
- Get total blog category countget
/blog-categories/{id}

Blog Tags

/blog-tags
- List blog tagsget
- Create a new blog tagpost
/blog-tags/count
- Get total blog tag countget
/blog-tags/{id}

Blog Posts

/blog-posts
- List blog postsget
- Create a new blog postpost
/blog-posts/count
- Get total blog post countget
/blog-posts/{id}

Website Pages

/pages
- List pagesget
- Create a new pagepost
/pages/count
- Get total page countget
/pages/{id}

Themes

/themes
- List themesget
/themes/count
- Get total theme countget
/themes/{id}
- Get a specific themeget
- Update a themeput

Theme Assets

/theme-assets/{theme_id}
/theme-assets/{theme_id}/asset

301 Redirects

/redirects
- List 301 redirectsget
- Create a new 301 redirectpost
/redirects/count
- Get total 301 redirect countget
/redirects/{id}
- Get a specific 301 redirectget
- Delete a 301 redirectdel

ShopWired Payments Transactions

/shopwired-payments/transactions
- List transactionsget
/shopwired-payments/transactions/count
- Get total transaction countget
/shopwired-payments/transactions/{transaction_id}
- Get a specific transactionget

Powered by

Deletes all app data

delete

https://api.ecommerceapi.uk/v1/app/data

Deletes all app data.

Language

Credentials

OAuth2

Bearer

Response

Click Try It! to start a request and see the response here!