Notify Aggregator Product Status

POST/dana/bizcenter/digitalgoods/product/notify-status.htm

This API is used for merchant to inform DANA of the availability status of aggregator product

API Type

SNAP API

Expected Timeout

8 second

SNAP Service Code

-

Accept

application/json

Content Type

application/json

This API is used for the following solution:

Digital Goods

Digital Goods are enables partners to provide digital products within the DANA system, from publishing and synchronizing product catalogs, validating customer information, creating transactions, to tracking order status.

---

version

string

1 - 8 charactersRequired

API version. As per the respective API reference

function

string

1 - 128 charactersRequired

According to specifications defined by each business domain
Value: dana.digital.goods.product.notifystatus

reqTime

string

25 charactersRequired

Request time, in format YYYY-MM-DDTHH:mm:ss+07:00.
Time must be in GMT+7 (Jakarta time)

reqMsgId

string

1 - 64 charactersRequired

Identify a unique system request. Each request will be assigned with a unique identifier (UUID)

---

aggregatorId

string

1 - 64 charactersRequired

Unique code identifier for each DANA aggregator

productStatusList

array of json object

1 - 10 charactersRequired

List of product status with maximum 10 products to notify.

Note

Only 10 max productStatusList for every hit

productId

string

1 - 128 charactersRequired

Aggregator product identifier

productStatus

string

1 - 64 charactersRequired

Aggregator product status. The possible values are:

• AVAILABLE
• UNAVAILABLE
• DISCONTINUE

Refer to ProductStatusEnum

AVAILABLE

the product is available

• If current status is ENABLE, DANA will keep it ENABLE.
• If current status is DISABLE, DANA will ENABLE the product automatically.

UNAVAILABLE

the product is temporary unavailable

• If current status is ENABLE, DANA will DISABLE the product automatically
• If current status is DISABLE, DANA will keep it DISABLE

DISCONTINUE

the product is discontinue

If current status is ENABLE or DISABLE, DANA will permanently DISABLE the product automatically.
Notes:

• After this change, this product will no longer be able to receive notification by Aggregator
• Only DANA Team can re-activate this product

{
  "request": {
    "head": {
      "version": "1.0",
      "function": "dana.digital.goods.product.notifystatus",
      "reqTime": "2018-07-04T12:08:56+07:00",
      "reqMsgId": "1234567asdfasdf1123fd123123aasd123"
    },
    "body": {
      "aggregatorId": "aggregator-code",
      "productStatusList": [
        {
          "productId": "aggregator-product-a",
          "productStatus": "AVAILABLE"
        },
        {
          "productId": "aggregator-product-b",
          "productStatus": "UNAVAILABLE"
        },
        {
          "productId": "aggregator-product-c",
          "productStatus": "DISCONTINUE"
        }
      ]
    }
  },
  "signature": "signature string"
}

---

version

string

1 - 8 charactersRequired

API version. As per the respective API reference

function

string

1 - 128 charactersRequired

According to specifications defined by each business domain
Value: dana.digital.goods.product.notifystatus

respTime

string

25 charactersRequired

Response time, in format YYYY-MM-DDTHH:mm:ss+07:00.
Time must be in GMT+7 (Jakarta time)

reqMsgId

string

1 - 64 charactersRequired

Identify an unique system request. Each request will be assigned with a unique identifier (UUID)

---

aggregatorId

string

1 - 64 charactersRequired

Unique code identifier for each DANA aggregator

notifyStatus

json object

Required

Notification result status in API level

productStatusList

array of json object

1 - 10 charactersConditional

List of product status with maximum 10 products to notify.

Conditional Info

Y:= notifyStatus.status is SUCCESS

Note

Only 10 max productStatusList for every hit

productId

string

1 - 128 charactersRequired

Aggregator product identifier

productStatus

string

1 - 64 charactersRequired

Aggregator product status. The possible values are:

• AVAILABLE
• UNAVAILABLE
• DISCONTINUE

Refer to ProductStatusEnum

AVAILABLE

the product is available.

• If current status is ENABLE, DANA will keep it ENABLE.
• If current status is DISABLE, DANA will ENABLE the product automatically.

UNAVAILABLE

the product is temporary unavailable.

• If current status is ENABLE, DANA will DISABLE the product automatically.
• If current status is DISABLE, DANA will keep it DISABLE.

DISCONTINUE

the product is discontinue.

If current status is ENABLE or DISABLE.
DANA will Permanently DISABLE the product automatically.
Notes:

• After this change, this product will no longer be able to receive notification by Aggregator.
• Only DANA Team can re-activate this Product.

notifyStatus

json object

Required

Notification result status in product level

code

string

1 - 8 charactersRequired

Notify Result Code

status

string

1 - 16 charactersRequired

Notify Result Status

message

string

1 - 256 charactersRequired

Notify Result message

retryable

boolean

1 - 5 charactersRequired

Retry able process for merchant.
The possible value are true or false

Response Failed with Param Illegal Error

{
  "response": {
    "head": {
      "version": "1.0",
      "function": "dana.digital.goods.product.notifystatus",
      "respTime": "2018-07-04T12:08:56+07:00",
      "reqMsgId": "1234567asdfasdf1123fd123123aasd123"
    },
    "body": {
      "aggregatorId": "aggregator-code",
      "notifyStatus": {
        "code": "31",
        "status": "PARAM_ILLEGAL",
        "message": "Parameter Illegal",
        "retryable": false
      }
    }
  },
  "signature": "signature string"
}

---

ResultStatus	ResultCodeId	ResultCode	ResultMessage	Solution
S	10	SUCCESS	Success	Stop send callback API
F	31	PARAM_ILLEGAL	Parameter Illegal	Stop send callback API
F	32	API_LIMIT_REACHED	API Call is reached the minute limit	Retry at the next minute
F	41	PRODUCT_NOT_FOUND	Product is not registered in DANA	Stop send callback API
U	99	SYSTEM_ERROR	Internal system Error	Try re-hit callback API