Integration Document

1. Partner registration / How to register your shop to SportDeal / SDeal

I. Contact our support team via the contact form on https://www.sportdeal.nl/word-deal-partner
II. Send an email to [email protected] with your basic shop details.
III. Get the approval via email with basic details, like supplier login credential.

2. Upload your product/setup product feed for SportDeal / SDeal

We are supporting multiple option to upload/manage the products to our system using feed manager.

I. XML Feed: You could create an XML feed for manage/update the product data. (ask for a sample file, if needed)
II. CSV Feed: You could create an CSV feed for manage/update the product data. (ask for a sample file, if needed)
III. We are supporting all the below listed method to read the feed.

a) HTTP: Here you create an URL for a feed and send the details to us by email.
b) FTP: Here you can place the file in your FTP folder and send the basic authentication details with folder path.
c) FTPS: Here you can place the file in your FTPS folder and send the basic authentication details with folder path.
d) SFTP: Here you can place the file in your SFTP folder and send the basic authentication details with folder path.
e) Don’t worry, if you do not have any above system in placed, we are supporting the local file also, you could send the feed file XML/CSV to our support team, we will create the basic FTP system for you and share the details.


3. How to process the order in SportDeal / SDeal

I. Once you have recived the order partner logging details, you can log in on supplier login
II. Here you can find all details of all orders.
III. You need to confirm the order with a delivery date.
IV. We are supporting multiple order methods for order process like: EffectConnect, ChannelEngine, FTP and SFTP.

4. Partner authentication process

Here the partner can authenticate the token and they can update/delete it.


I. Login into partner account by navigating to https://supplier.sdeal.nl/
II. Go to Menu and click on API.
III. You will find the option for create an API key. Please create the API key here.

API Create

IV. You can see the API Key and supplier ID after generating.

API Create Success

5. API for supplier order process

Note: You can map the order status via these codes

order_status_code      status
1 CREATED
5 WAITING_APPROVAL
8 WAITING_HOLIDAY
10 SENT_TO_SUPPLIER
20 CONFIRMED
25 CANCELED
50 RECEIVED
51 COMPLETED

-> You find your supplier_id below the API Key in your partner account.

API Supplier ID

I. Read the order from SportDeal / SDeal based on order ids.

API END Point: https://www.sportdeal.nl/rest/V1/supplier/orders/?

searchCriteria[filter_groups][0][filters][0][field]=supplier_id&
searchCriteria[filter_groups][0][filters][0][value]=1773&
searchCriteria[filter_groups][0][filters][0][condition_type]=eq&
searchCriteria[filter_groups][1][filters][0][field]=id&
searchCriteria[filter_groups][1][filters][0][value]=3496,3478&
searchCriteria[filter_groups][1][filters][0][condition_type]=in

Method: GET
Header: Authorization : Supplier API Key
Note: You can pass the multiple ids of order as comma separated to get details
Response:

{

“items”: [

{

“id”: “3478”,
“supplier_id”: “1773”,
“supplier_quote_id”: “1663”,
“supplier_name”: “OV Stock”,
“order_type”: “4”,
“order_status”: “20”,
“finance_status”: “50”,
“supplier_invoice_number”: null,
“payment_schedule”: “2021-08-18”,
“reject_reason”: null,
“invoice_reminder_sent”: null,
“invoice_reject_sent”: null,
“invoice_accept_sent”: null,
“payment_date”: “2021-08-19”,
“direct_cost_price”: “6.7800”,
“final_cost_price”: “6.7800”,
“indirect_discount”: “0.0000”,
“delivery_cost”: “5.2700”,
“expected_arrival_date”: “2021-06-24”,
“note”: null,
“created_at”: “2021-06-23 20:05:46”,
“updated_at”: “2021-08-19 08:21:11”,
“confirmed_at”: null,
“reminder_sent_at”: null,
“original_expected_arrival_date”: “2021-06-23”,
“confirmed_expected_arrival_date”: “2021-06-24”,
“external_order_id”: null,
“completely_received_date”: null,
“commission”: “0.000000”

},

{

“id”: “3496”,
“supplier_id”: “1773”,
“supplier_quote_id”: “1681”,
“supplier_name”: “OV Stock”,
“order_type”: “4”,
“order_status”: “25”,
“finance_status”: null,
“supplier_invoice_number”: null,
“payment_schedule”: null,
“reject_reason”: null,
“invoice_reminder_sent”: null,
“invoice_reject_sent”: null,
“invoice_accept_sent”: null,
“payment_date”: null,
“direct_cost_price”: “0.0000”,
“final_cost_price”: “0.0000”,
“indirect_discount”: “0.0000”,
“delivery_cost”: “5.2681”,
“expected_arrival_date”: null,
“note”: null,
“created_at”: “2021-07-07 23:00:28”,
“updated_at”: “2021-07-19 10:18:25”,
“confirmed_at”: null,
“reminder_sent_at”: null,
“original_expected_arrival_date”: “2021-07-07”,
“confirmed_expected_arrival_date”: null,
“external_order_id”: null,
“completely_received_date”: null,
“commission”: “0.000000”

}

],
“search_criteria”: {

“filter_groups”: [

{

“filters”: [

{

“field”: “supplier_id”,
“value”: “1773”,
“condition_type”: “eq”

}

]

},
{

“filters”: [

{

“field”: “id”,
“value”: “3496,3478”,
“condition_type”: “in”

}

]

}

]

},
“total_count”: 2

}


II. Read the order from SportDeal / SDeal based on order id.
API END Point: https://www.sportdeal.nl/rest/V1/supplier/order/3496

Method: GET
Header: Authorization : Supplier API Key
Note: You have to pass your order id in request url
Response:

{

“id”: “3496”,
“supplier_id”: 1773,
“supplier_quote_id”: 1681,
“supplier_name”: “OV Stock”,
“order_type”: 4,
“order_status”: 25,
“reject_reason”: null,
“delivery_cost”: 5.2681,
“created_at”: [],
“external_order_id”: null,
“direct_cost_price”: 0,
“final_cost_price”: 0,
“commission”: 0,
“indirect_discount”: 0,
“expected_arrival_date”: null,
“original_expected_arrival_date”: [],
“confirmed_expected_arrival_date”: null,
“payment_schedule”: null,
“payment_date”: null,
“finance_status”: null,
“note”: null

}


III. Read the order from SportDeal / SDeal based on order status.
API END Point: https://www.sportdeal.nl/rest/V1/supplier/orders/?

searchCriteria[filter_groups][0][filters][0][field]=supplier_id&
searchCriteria[filter_groups][0][filters][0][value]=1773&
searchCriteria[filter_groups][0][filters][0][condition_type]=eq&
searchCriteria[filter_groups][1][filters][0][field]=order_status&
searchCriteria[filter_groups][1][filters][0][value]=10&
searchCriteria[filter_groups][1][filters][0][condition_type]=eq


Method: GET
Header: Authorization : Supplier API Key
Note: You can see the status map table on top you need to pass the status code for value of order_status
Response:

{

“items”: [

{

“id”: “2920”,
“supplier_id”: “1773”,
“supplier_quote_id”: “1105”,
“supplier_name”: “OV Stock”,
“order_type”: “4”,
“order_status”: “10”,
“finance_status”: null,
“supplier_invoice_number”: null,
“payment_schedule”: null,
“reject_reason”: null,
“invoice_reminder_sent”: null,
“invoice_reject_sent”: null,
“invoice_accept_sent”: null,
“payment_date”: null,
“direct_cost_price”: “20.0000”,
“final_cost_price”: “20.0000”,
“indirect_discount”: “0.0000”,
“delivery_cost”: “6.0000”,
“expected_arrival_date”: null,
“note”: null,
“created_at”: “2021-02-03 06:33:56”,
“updated_at”: “2021-06-22 15:52:57”,
“confirmed_at”: null,
“reminder_sent_at”: null,
“original_expected_arrival_date”: “2021-02-04”,
“confirmed_expected_arrival_date”: null,
“external_order_id”: null,
“completely_received_date”: null,
“commission”: “0.000000”

}

],
“search_criteria”: {
“filter_groups”: [

{

“filters”: [

{

“field”: “supplier_id”,
“value”: “1773”,
“condition_type”: “eq”

}

]

},
{

“filters”: [

{

“field”: “order_status”,
“value”: “10”,
“condition_type”: “eq”

}

]

}

]

},
“total_count”: 1
}


IV. Read the order from SportDeal / SDeal based on date range.
API END Point: https://www.sportdeal.nl/rest/V1/supplier/orders/?

searchCriteria[filter_groups][0][filters][0][field]=supplier_id&
searchCriteria[filter_groups][0][filters][0][value]=1773&
searchCriteria[filter_groups][0][filters][0][condition_type]=eq&
searchCriteria[filter_groups][1][filters][0][field]=created_at&
searchCriteria[filter_groups][1][filters][0][condition_type]=from&
searchCriteria[filter_groups][1][filters][0][value]=2021-07-07 00:00:00&
searchCriteria[filter_groups][2][filters][0][field]=created_at&
searchCriteria[filter_groups][2][filters][0][condition_type]=to&
searchCriteria[filter_groups][2][filters][0][value]=2021-07-07 23:59:59

Method: GET
Header: Authorization : Supplier API Key
Note: You can use the date range to get order details, date format is Y-m-d H:i:s
Response:

{

“items”: [

{

“id”: “3496”,
“supplier_id”: “1773”,
“supplier_quote_id”: “1681”,
“supplier_name”: “OV Stock”,
“order_type”: “4”,
“order_status”: “25”,
“finance_status”: null,
“supplier_invoice_number”: null,

“payment_schedule”: null,
“reject_reason”: null,
“invoice_reminder_sent”: null,
“invoice_reject_sent”: null,
“invoice_accept_sent”: null,
“payment_date”: null,
“direct_cost_price”: “0.0000”,
“final_cost_price”: “0.0000”,
“indirect_discount”: “0.0000”,
“delivery_cost”: “5.2681”,
“expected_arrival_date”: null,
“note”: null,
“created_at”: “2021-07-07 23:00:28”,
“updated_at”: “2021-07-19 10:18:25”,
“confirmed_at”: null,
“reminder_sent_at”: null,
“original_expected_arrival_date”: “2021-07-07”,
“confirmed_expected_arrival_date”: null,
“external_order_id”: null,
“completely_received_date”: null,
“commission”: “0.000000”

}

],
“search_criteria”: {
“filter_groups”: [


{

“filters”: [

{

“field”: “supplier_id”,
“value”: “1773”,
“condition_type”: “eq”

}

]

},
{

“filters”: [

{

“field”: “created_at”,
“value”: “2021-07-07 00:00:00”,
“condition_type”: “from”

}

]

},
{

“filters”: [

{

“field”: “created_at”,
“value”: “2021-07-07 23:59:59”,
“condition_type”: “to”

}

]

}

]
},
“total_count”: 1
}


V. Confirm the order from SportDeal / SDeal based on order id.
API END Point: https://www.sportdeal.nl/rest/V1/supplier/order/confirm/2920

Method: GET
Header: Authorization : Supplier API Key
Note: You need to pass the order id in URL request.
Response:

{

“id”: “2920”,
“supplier_id”: 1773,
“supplier_quote_id”: 1105,
“supplier_name”: “OV Stock”,
“order_type”: 4,
“order_status”: 20,
“reject_reason”: null,
“delivery_cost”: 6,
“created_at”: [],
“external_order_id”: null,
“direct_cost_price”: 20,
“final_cost_price”: 20,
“commission”: 0,
“indirect_discount”: 0,
“expected_arrival_date”: null,
“original_expected_arrival_date”: [],
“confirmed_expected_arrival_date”: null,
“payment_schedule”: null,
“payment_date”: null,
“finance_status”: null,
“note”: null

}