MyDeal provides JSON-based REST APIs which you can integrate with to easily manage your product listings, orders and fulfillment.
If you are interested in integrating to the MyDeal API, please submit a request here and a MyDeal Agent will get back to you as soon as possible. To speed up the process, please provide your arrangements for Steps 1) and 2) below in the request description.
The following steps outline how you can integrate your store via the MyDeal API. Please ensure you have read our API Documentation thoroughly before carrying out these steps.
Step 1 - Select your Product Key Identifier: ExternalProductID or ProductSKU
- This value must be unique per product and will be used for all API calls
- If you have a unique SKU for each product, use ProductSKU as Product Key Identifier for the MyDeal API Integration
- If you may have duplicate SKUs across your products, use ExternalProductID as Product Key Identifier for the MyDeal API Integration
Step 2 - Confirm your Shipping Arrangement on MyDeal
- Flat = flat rate shipping per unit
- FlatAnyQty = flat rate shipping regardless of quantity ordered for the same product
- Shipping Rate Table Calculator
Step 3 - We will setup your store in our Sandbox Environment and provide your Sandbox API credentials.
- Sandbox API URL = [to be provided by the MyDeal Team]
- Sandbox ClientID = [to be provided by the MyDeal Team]
- Sandbox ClientSecret = [to be provided by the MyDeal Team]
- Sandbox SellerID = [to be provided by the MyDeal Team]
- Sandbox SellerToken = [to be provided by the MyDeal Team]
- Sandbox Store URL = [to be provided by the MyDeal Team]
Step 4 - Once you have received your Sandbox API credentials, please test each of the following API Integration Flow in the Sandbox Environment
- I. Authentication (Endpoint: '/mydealaccesstoken')
- II. Product Create and Content Update (Endpoint: '/products')
- III. Product Price and Stock Update (Endpoint: '/products/quantityprice')
- IV. Fetch and Acknowledge Orders (Endpoint: '/orders')
- V. Fulfill Orders (Endpoint: '/orders/fulfill')
- VI. Order Refund and Cancellation (Endpoints: '/orders/{orderId}/cancel', '/orders/{orderId}/refund')
NOTE:
- Pre-filled Postman Scripts to test the integration flows in our Sandbox Environment will be provided via email.
- Refer to the following spreadsheet to see all the test scenarios you need to conduct. Then, verify your test results based on the questionnaire in each scenario
- Test Credit Card Details for Order Integration Testing will be provided email. This step can only be done once you've created Products via the API. Please ensure you are only purchasing products from your store, otherwise, you will encounter errors.
- For simplicity purpose, please setup your products with 'Flat' / 'FlatAnyQty' shipping arrangement in the Sandbox Environment. If you want to list your products with a Shipping Rate Table Calculator, we will create the shipping calculator when you are ready to integrate to our Live Environment. A CustomFreightSchemeID will then be supplied for you to apply to your products.
Step 5 - Please notify your MyDeal Agent once you have tested all the API integration flows in our Sandbox Environment
- We will verify your test results and provide any feedback
Step 6 - Once all your test results have been validated, we will create your store in our Live Environment and provide your Live API credentials
- Live API URL = [to be provided by the MyDeal Team]
- Live ClientID = [to be provided by the MyDeal Team]
- Live ClientSecret = [to be provided by the MyDeal Team]
- Live SellerID = [to be provided by the MyDeal Team]
- Live SellerToken = [to be provided by the MyDeal Team]
- Live Store URL = [to be provided by the MyDeal Team]
Step 7 - Publish your products in our Live Environment to start selling on MyDeal!
- To list your products with your Shipping Rate Table Calculator, apply the following arrangements per product:
-
- ShippingCostCategory = 'Custom'
- CustomFreightSchemeID = '[to be provided by the MyDeal Team]'
-
Resources