Get Saldo History

This endpoint returns seller saldo history from Shop ID that associated with FS ID. This endpoint has two types of response as json format and files format with .xls extension

Path

get

/v1/fs/:fs_id/shop/:shop_id/saldo-history

Request Parameters

Parameter	Type	Required	Location	Description
fs_id	Integer	Required	path	Fulfillment service unique identifier
shop_id	Integer	Required	path	Shop service unique identifier
from_date	String	Required	query	UNIX timestamp of date (hour, min, sec) from which the order details are requested. Max Range per request 31 Days
to_date	String	Required	query	UNIX timestamp of date (hour, min, sec) to which the order details are requested. Max Range per request 31 Days
page	Integer	Required	query	Determine which page the order list should start. Start from 1. You can get the next page when the previous page has have_next_page value true
per_page	Integer	Required	query	Determine how many orders will be shown per page. The maximum value is 500
export	Integer	Optional	query	When the value is 1 then data will be send as files with .xls extension

Example Request

Curl

curl -X GET \
    'https://fs.tokopedia.net/v1/fs/13138/shop/6549744/saldo-history?page=1&per_page=10&from_date=2020-12-01&to_date=2021-01-01' \
    -H 'Authorization: Bearer EUqcir9oRCqNr_9OuvZgkg' 

Response Parameters

Name	Type	Demo Value	Description
have_next_page	Boolean	false
saldo_history	Object Array

Success Response Examples

{
  "header": {
    "process_time": 0.016533477,
    "messages": "Your request has been processed successfully"
  },
  "data": {
    "have_next_page": false,
    "saldo_history": [
      {
        "deposit_id": 9200019404,
        "type_description": "Disbursement to Seller Marketplace",
        "Type": 1001,
        "class": "Transaction",
        "amount": 4000,
        "note": "Transaksi Penjualan Berhasil - INV/20201208/XX/XII/42978",
        "create_time": "2020-12-08 13:33:56",
        "withdrawal_date": "",
        "withdrawal_status": 0,
        "saldo": 0,
        "image": "https://ecs7.tokopedia.net/img/saldo/transaction.png"
      }
    ]
  }
}

Error Response Examples

{
  "header": {
    "process_time": 0.00002147,
    "messages": "We could not process your request due to malformed request, please check again",
    "reason": "Date format is not valid",
    "error_code": "SHP_DLV_005"
  },
  "data": null
}

Error Codes

Error Code	Error Message	Description
SHP_GRPC_001	Failed Send GRPC Request	Failed sending request to upstream
SHP_GRPC_003	Data Not Found	Failed finding data from upstream
SHP_USC_001	FS ID is not associated with Shop ID	FS ID is not connected with the Shop ID, please kindly check
SHP_USC_002	Shop Owner is not found	Shop owner info not found, please kindly check
SHP_DLV_001	FS ID is not valid	Invalid FS ID, please kindly check
SHP_DLV_002	Shop ID is not valid	Invalid Shop ID, please kindly check
SHP_DLV_003	Page format is not valid	Invalid Page format, please kindly check
SHP_DLV_004	Per Page format is not valid	Invalid Per Page format, please kindly check
SHP_DLV_005	Date format is not valid	Invalid Date format, please kindly check
SHP_DLV_007	Date Range must be less than %d days	Invalid Date Range value, please kindly check