Back to top

Dsync Connector (Source)

Outgoing requests from the system connector.

Resource Group

Entities

Create an entity
POST/api/realtime

Send a “create” request to Dsync

Example URI

POST http://dsync.example//api/realtime
Request
HideShow
Headers
Content-Type: application/json
Auth-Token: 080ab6bd49b138594ac9647dc929122adfb983c8
Entity-Token: source-1-product-462705796aa4d94d3a35d7254637a943
Body
{
  "type_id": "simple",
  "sku": "hde012",
  "name": "Madison 8GB Digital Media Player",
  "meta_title": null,
  "meta_description": null,
  "url_key": "madison-8gb-digital-media-player",
  "url_path": "madison-8gb-digital-media-player.html",
  "custom_design": null,
  "page_layout": "1 column",
  "options_container": "Product Info Column",
  "image_label": null,
  "small_image_label": null,
  "thumbnail_label": null,
  "country_of_manufacture": "AU",
  "msrp_enabled": "Use config",
  "msrp_display_actual_price_type": "Use config",
  "gift_message_available": "No",
  "gift_wrapping_available": "No",
  "color": "Black",
  "status": "Enabled",
  "visibility": "Catalog, Search"
}
Response  200
HideShow

The “create” request was received and didn’t encounter any issues.

Headers
Content-Type: application/json
Body
{
  "status": 200,
  "message": "OK",
  "detail": {},
  "data": {
    "process_id": "123456"
  }
}
Response  202
HideShow

The “create” request has been accepted for processing, but the processing has not been completed.

Headers
Content-Type: application/json
Body
{
  "status": 202,
  "message": "Accepted",
  "detail": {},
  "data": {}
}
Response  400
HideShow

The “create” request cannot or will not be processed due to something that is missing/invalid in the request.

Headers
Content-Type: application/json
Body
{
  "status": 400,
  "message": "Bad Request",
  "detail": {
    "[sku]": "This value should not be blank."
  },
  "data": {}
}
Response  401
HideShow

The “create” request will not be processed because authentication is required and has failed or has not been provided.

Headers
Content-Type: application/json
Body
{
  "status": 401,
  "message": "Unauthorized",
  "detail": {},
  "data": {}
}
Response  500
HideShow

The “create” request cannot be processed because an unexpected condition was encountered by the server.

Headers
Content-Type: application/json
Body
{
  "status": 500,
  "message": "Internal Server Error",
  "detail": {},
  "data": {}
}

Update an entity
PUT/api/realtime

Send an “update” request to Dsync

Example URI

PUT http://dsync.example//api/realtime
Request
HideShow
Headers
Content-Type: application/json
Auth-Token: 080ab6bd49b138594ac9647dc929122adfb983c8
Entity-Token: source-1-product-462705796aa4d94d3a35d7254637a943
Entity-Id: msj006c-Royal
Body
{
  "type_id": "simple",
  "sku": "msj006c-Royal",
  "has_options": "0",
  "required_options": "0",
  "created_at": "2014-11-23T10:54:39+00:00",
  "updated_at": "2016-03-07 05:01:51",
  "name": "Plaid Cotton Shirt-Royal Blue-L",
  "meta_title": "",
  "meta_description": "",
  "url_key": "plaid-cotton-shirt-royal-blue-l",
  "url_path": "plaid-cotton-shirt-royal-blue-l.html",
  "custom_design": "",
  "page_layout": "1 column",
  "options_container": "Product Info Column",
  "image_label": "",
  "small_image_label": "",
  "thumbnail_label": "",
  "country_of_manufacture": "",
  "msrp_enabled": "Use config",
  "msrp_display_actual_price_type": "Use config",
  "gift_message_available": "",
  "gift_wrapping_available": "0",
  "is_samsung": "",
  "color": "Royal Blue",
  "status": "Enabled",
  "visibility": "Not Visible Individually",
  "tax_class_id": "Taxable Goods",
  "occasion": "Casual",
  "apparel_type": "Shirts",
  "sleeve_length": "Long Sleeve",
  "fit": "Regular",
  "size": "L",
  "length": "",
  "gender": "Male",
  "description": "Available in Sharp fit. Refined collar. Button cuff. Cotton. Machine wash. Made in US.",
  "short_description": "This everyday shirt is equally stylish with jeans or trousers.",
  "meta_keyword": "",
  "custom_layout_update": "",
  "special_from_date": "",
  "special_to_date": "",
  "news_from_date": "",
  "news_to_date": "",
  "custom_design_from": "",
  "custom_design_to": "",
  "price": "160.00",
  "special_price": "",
  "weight": "1.0000"
}
Response  200
HideShow

The “update” request was received and didn’t encounter any issues.

Headers
Content-Type: application/json
Body
{
  "status": 200,
  "message": "OK",
  "detail": {},
  "data": {
    "process_id": "123456"
  }
}
Response  202
HideShow

The “update” request has been accepted for processing, but the processing has not been completed.

Headers
Content-Type: application/json
Body
{
  "status": 202,
  "message": "Accepted",
  "detail": {},
  "data": {}
}
Response  400
HideShow

The “update” request cannot or will not be processed due to something that is missing/invalid in the request.

Headers
Content-Type: application/json
Body
{
  "status": 400,
  "message": "Bad Request",
  "detail": {
    "[sku]": "This value should not be blank."
  },
  "data": {}
}
Response  401
HideShow

The “update” request will not be processed because authentication is required and has failed or has not been provided.

Headers
Content-Type: application/json
Body
{
  "status": 401,
  "message": "Unauthorized",
  "detail": {},
  "data": {}
}
Response  500
HideShow

The “update” request cannot be processed because an unexpected condition was encountered by the server.

Headers
Content-Type: application/json
Body
{
  "status": 500,
  "message": "Internal Server Error",
  "detail": {},
  "data": {}
}

Delete an entity
DELETE/api/realtime

Send a “delete” request to Dsync

Example URI

DELETE http://dsync.example//api/realtime
Request
HideShow
Headers
Content-Type: application/json
Auth-Token: 080ab6bd49b138594ac9647dc929122adfb983c8
Entity-Token: source-1-product-462705796aa4d94d3a35d7254637a943
Entity-Id: msj006c-Royal
Body
{}
Response  200
HideShow

The “delete” request was received and didn’t encounter any issues.

Headers
Content-Type: application/json
Body
{
  "status": 200,
  "message": "OK",
  "detail": {},
  "data": {
    "process_id": "654321"
  }
}
Response  202
HideShow

The “delete” request has been accepted for processing, but the processing has not been completed.

Headers
Content-Type: application/json
Body
{
  "status": 202,
  "message": "Accepted",
  "detail": {},
  "data": {}
}
Response  400
HideShow

The “delete” request cannot or will not be processed due to something that is missing/invalid in the request.

Headers
Content-Type: application/json
Body
{
  "status": 400,
  "message": "Bad Request",
  "detail": {},
  "data": {}
}
Response  401
HideShow

The “delete” request will not be processed because authentication is required and has failed or has not been provided.

Headers
Content-Type: application/json
Body
{
  "status": 401,
  "message": "Unauthorized",
  "detail": {},
  "data": {}
}
Response  500
HideShow

The “delete” request cannot be processed because an unexpected condition was encountered by the server.

Headers
Content-Type: application/json
Body
{
  "status": 500,
  "message": "Internal Server Error",
  "detail": {},
  "data": {}
}

Process Notifications

Send a process notification
POST/api/realtime/notification

Send a process notification for an accepted request

Example URI

POST http://dsync.example//api/realtime/notification
Request
HideShow
Headers
Content-Type: application/json
Auth-Token: 080ab6bd49b138594ac9647dc929122adfb983c8
Process-Id: 123456
Body
{
  "process_id": "123456",
  "status": "500",
  "message": "Server error updating entity",
  "detail": {},
  "data": {}
}
Response  200
HideShow

The notification has been received and didn’t encounter any issues.

Headers
Content-Type: application/json
Body
{
  "status": 200,
  "message": "OK",
  "detail": {},
  "data": {}
}
Response  400
HideShow

The notification cannot or will not be processed due to something that is missing/invalid in the request.

Headers
Content-Type: application/json
Body
{
  "status": 400,
  "message": "Bad Request",
  "detail": {},
  "data": {}
}
Response  401
HideShow

The notification will not be processed because authentication is required and has failed or has not been provided.

Headers
Content-Type: application/json
Body
{
  "status": 401,
  "message": "Unauthorized",
  "detail": {},
  "data": {}
}
Response  500
HideShow

The notification cannot be processed because an unexpected condition was encountered by the server.

Headers
Content-Type: application/json
Body
{
  "status": 500,
  "message": "Internal Server Error",
  "detail": {},
  "data": {}
}

Generated by aglio on 19 Oct 2016