IPOS ERPAPIDocumentation 091121 0609 36028

ERP API Documentation
How to Access API

Authentication
API Access
CreateProducts
Parameters
Product
Variant
Composite
Comboset
Outlet Prices
Sample Usage (Type = Standard)
Sample Usage (Type = Variant)
Sample Usage (Type = Composite)
Sample Usage (Type = Comboset)
Response
Products
UpdateProducts
Parameters
Variant
Composite
Comboset
Outlet Prices
Sample Usage
Response
Products
SetFinalStock
Parameters
Product
Sample Usage
Response
Product
CreateTransfer
Parameters
Product
Sample Usage (Type = In)
Sample Usage (Type = Out, Out_Type = To Outlet)
Sample Usage (Type = Out, Out_Type = Return Supplier)
Response
GetTransfer
Parameters
Sample Usage
Response
InventoryAdjustments
Items (Action = Accept)
Items (Action = Start / Adjustment / Opname)
GetOutletInventories
Parameters
Sample Usage
Response
InventoryList
GetCustomers
Parameter
Sample Usage
Response
CustomerList
CustomerAddresses
GetStoreInfo
Sample Usage
Response
StoreInfo
Outlet
PaymentType
CancelOrder
Parameters
Sample Usage
Response
Refund Details
CreateCustomer
Parameter
Sample Usage
Response
Customer
UpdateCustomer
Parameter
Sample Usage
Response
Customer
GetCustomer
Parameter
Sample Usage
Response
CustomerList
CustomerAddresses
UpdateCustomerAddresses
Parameter
Addresses
Sample Usage
Response
Addresses
AddCustomerAddresses
Parameter
Addresses
Sample Usage
Response
Addresses
DeleteCustomerAddresses
Parameter
Sample Usage
Response
Change Logs
3 November 2021
Add visibility and outlet_visibility on CreateProducts and UpdateProducts request body
23 April 2021
Add product_type and vendor on CreateProducts and UpdateProducts request body
13 April 2021
Add New API DeleteCustomerAddresses
24 Maret 2021
Add New API AddCustomerAddresses
19 Maret 2021
Add parameter includes for request on GetCustomers

Add parameter external_customer_id and customer_addresses for response on GetCustomers
Add New API GetCustomer and UpdareCustomerAddresses
17 February 2021
Add CreateCustomer and UpdateCustomer API
1 December 2020
Add information Source and Destination Outlet / Supplier on GetTransfer API
12 October 2020
Add List of Object (OutletPrices) on CreateProducts and UpdateProducts API
6 October 2020
Add CancelOrder's API
25 August 2020
Add parameter transfer_type and out_type on GetTransfer API

Add flagging response OutType for differentiator between out to supplier / out between outlets
30 July 2020
Add parameter modified_after on GetCustomers
30 April 2020
Add parameter BuyingPrice (buying price input from transfer in) on GetTransfer API
27 February 2020
Adding new API

GetCustomers
GetStoreInfo version 3.0
Add transfer out on CreateTransfer's API with the details
17 February 2020
Add parameter TransferId on GetTransfer's API
6 February 2020
Add parameter reference_code on CreateTransfer's API
How to Access API

Authentication
Access token is needed to make request to the API. The authentication process using Postman as follows:
1. Change the Authorization Type to OAuth 2.0
2. Set Add token to Header

2.
3. Create new access token by clicking Get New Access Token
4. Specify request token info, then click request token
Grant Type Client Credentials
Access Token Url https://isellershop.com/oauth/token
Client ID A unique string issue by iSeller to you when your app was registered.
Client Secret A unique string issue by iSeller to you when your app was registered.
5. Use token
API Access
For development, the <API URL> is <storename>.iseller.io

Example: grandf.iseller.io
For production, the <API URL> is <storename>.isellershop.com
Example: grandf.isellershop.com
Please replace <storename> with your store name. If you not sure about your store name, please consult us.
CreateProducts
https://<API URL>/api/v3/CreateProducts
Call this API to create products.
Parameters
Name Type Optional Description
products List of Object (Product) N List of products item
Product
sku String N SKU must be unique
name String N
handle String Y
barcode String Y
description String Y
type String N Value:

standard
variant
composite
comboset
product_type String Y
vendor String Y
visibility String Y Value:
pos
web
Example:
outlet_visibility String Y The outlet visibility only applies if visibility is POS.
The value is outlet code / outlet name.
If want to apply to all outlet visibility, don't input the outlet visibility on request
body.
Example:
price Decimal Y
outlet_prices List of Object Optional

(OutletPrices)
buying_price Decimal Y
taxable Boolean Y
track_inventory Boolean Y
continue_selling_when_sold_out Boolean Y
require_shipping Boolean Y
shipping_weight Decimal Y Required if require_shipping = true
shipping_unit String Y Required if require_shipping = true
Acceptable values:
lb
oz
kg
g
unit_of_measurement String Y
variants List of Object (Variant) Optional Required if type = variant
composite List of Object Optional Required if type = composite

(Composite)
comboset List of Object (Comboset) Optional Required if type = comboset
Variant
name String N
option String N
Composite
sku String N
quantity String N
Comboset
sku String N
quantity String N
category String N Product's comboset category
Outlet Prices
outlet_id String Y
price Decimal Y
Sample Usage (Type = Standard)
Sample Usage (Type = Variant)

Sample Usage (Type = Composite)
Sample Usage (Type = Comboset)
Response
{
"products": [
{
"product_id": "3ad99a65-508d-40a3-8cc0-fbe18172504a",
"sku": "GFSUSMYO0001",
"error_message": null,
"is_success": true
}
],
"status": true,
"time": "00:00:02.7187980"
}
Name Type Description
products List of Product List of Product response
error_message String The error message of the response
status Boolean The response status
time String The response time
Products
product_id String
sku String
error_message String Created product error message
is_success Boolean Created product status
UpdateProducts
https://<API URL>/api/v3/UpdateProducts
Call this API to update products.
Parameters
Product
sku String N SKU must be unique
name String N
handle String Y
barcode String Y
description String Y

standard
variant
composite
comboset
product_type String Y
vendor String Y
visibility String Y Value:
pos
web
Example:
outlet_visibility String Y The outlet visibility only applies if visibility is POS.

The value is outlet code / outlet name.
If want to apply to all outlet visibility, don't input the outlet visibility on request
body.
Example:
price Decimal Y
outlet_prices List of Object Optional

(OutletPrices)
buying_price Decimal Y Buying price can't be modified if buying price has been set
taxable Boolean Y
track_inventory Boolean Y
continue_selling_when_sold_out Boolean Y
require_shipping Boolean Y
shipping_weight Decimal Y Required if require_shipping = true
shipping_unit String Y Required if require_shipping = true
Acceptable values:
lb
oz
kg
g
unit_of_measurement String Y
variants List of Object (Variant) Optional Required if type = variant
composite List of Object (Composite) Optional Required if type = composite
Notes:
If null, make no changes to the composite data

If empty list, intended to delete all the composite data
comboset List of Object (Comboset) Optional Required if type = comboset
Notes:
If null, make no changes to the comboset data

If empty list, intended to delete all the comboset data
Variant
name String N
option String N
Composite
sku String N
quantity String N
Comboset
sku String N
quantity String N
category String N Product's comboset category
Outlet Prices
outlet_id String Y
price Decimal Y
Sample Usage
Response
{
"products": [
{
"product_id": "61182f25-7786-4ca8-bdf0-1aa6b7fc2ca0",
"sku": "10652",
"is_success": true
}
],
"status": true,
"time": "00:00:02.7187980"
}
products List of Product List of Product response

Products
product_id String
sku String
SetFinalStock
https://<API URL>/api/v3/SetFinalStock
Call this API to update stock.
Parameters
Product
product_id String Y Unique identifier of the product
Notes:
Required if sku not specified
sku String Y SKU of the product
Notes:
Required if product_id not specified

If both product_id and SKU filled, the data should match
outlet_code String N Unique identifier of the outlet
unit_in_stock Double N Product quantity to be assign to the product outlet
Sample Usage
Response
{
"product": null,
"status": true,
"time": "00:00:00.2812296"
}
product Product Product response
Product
product_id String
sku String
CreateTransfer
This API serves to make transfers using API.
https://<API URL>/api/v3/CreateTransfer
Use this API to create transfer.
Parameters
outlet_code String N Accordance with the outlet code in iSeller
in
out
out_type String Y Required if type = out
Value:
tooutlet
returnsupplier
supplier_name String Y Required if out_type = returnsupplier
destination_outlet_code String Y Required if out_type = tooutlet
status String N Value:
pending = status which means there is no processing of goods at all

started = status which means the item has started to be sent
completed = status which means all goods have been processed, including receipt, rejection,
and cancellation of goods
reference_code String Y Additional information for your reference
products List of Object N

(Product)
Product
sku String N SKU of the product
quantity Int N Quantity of product to transfer
Notes:
The quantity must be greater than 0
serialnumbers String Y Notes:
Required if product is require serial number

Required if type = in and status = completed
Required if type = out and status = started / completed
buyingprice Double Y Filled when type is transfer in
Sample Usage (Type = In)
Sample Usage (Type = Out, Out_Type = To Outlet)
Sample Usage (Type = Out, Out_Type = Return Supplier)

Response
{
"transfer_id": "846254f6-9474-4e6a-a5cd-5dff39e49d0e",
"status": true,
"time": "00:00:02.3281511"
}
transfer_id String Transfer ID of created transfer
error_message String Created transfer error message
time String The processing time of create transfer
GetTransfer
This API serves to find out inventory adjustment or entry and exit of the product.
https://<API URL>/api/v3/GetTransfer
Use this API to get transfer.
Parameters
created_after String N
created_before String N
page_size Int N The quantity of data to be retrieved
page Int N The page to which quantity of data will be retrieved
transfer_type String Y The transfer type

Value:
in
out
adjustment
opname
out_type String Y The transfer out type
Only allow value of transfer_type = out
Value:
returnsupplier
tooutlet
Sample Usage
Response
{
"HasNextItems": true,
"InventoryAdjustments": [
{
"By": "klassix@iseller.io",
"TransferId": "63b19968-d574-40a7-ac38-5cffbad89415",
"Id": "30bd896c-f9ee-4843-86f4-a65f7b57c517",
"Reference": "#T-011193",
"ExternalReference": "1321321321321",
"Date": "2020-02-03",
"Items": [
{
"SKU": "GA01",
"AcceptedQuantity": 1,
"RejectedQuantity": 0,
"CancelledQuantity": 0,
"BuyingPrice": 10000.0
}
],
"Outlet": "mag",
"Type": "in",
"OutType: null,
"Action": "accept"
},
{
"TransferId": "3d6b563a-f11f-4daa-b030-a3da6a1c394c",
"Id": "ab82ea5a-d65a-48b9-9128-8e0a7ba2c804",
"ExternalReference": "1231321321",
"Date": "2020-02-03",
"Items": [
{
"SKU": "GA01",
"AcceptedQuantity": 1,
"RejectedQuantity": 0,
"CancelledQuantity": 0,
"BuyingPrice": 20000.0
}
],
"Outlet": "mag",
"Type": "in",
"OutType: null,
"Action": "accept"
},
{
"TransferId": "377b57b8-465f-453f-9fab-1f3505f5215b",
"Id": "60eceb04-faf0-40a3-9231-8ce71085b0ec",
"Reference": "",
"ExternalReference": "",
"Date": "2020-02-03",
"Items": [
{
"SKU": "GA01",
"Quantity": 5,
}
],
"Outlet": "mo",
"Type": "adjustment",
"OutType: null,
"Action": "adjustment"
},
{
"TransferId": "8b085ea7-64cf-44f0-b5cc-ec8a0d005bc4",
"Id": "473fac10-78a8-454f-b810-a26b33cb4f2e",
"Reference": "2020-02-03 - Outlet Sunter by Lucas George",
"ExternalReference": "",
"Date": "2020-02-03",
"Items": [
{
"SKU": "GA01",
"Quantity": 5
}
],
"Outlet": "Outlet Sunter",
"Type": "opname",
"OutType": null
"Action": "opname"
},
{
"TransferId": "6ff20ed2-f4a3-44d7-ac33-4dc341bf33c7",
"Id": "0f812176-a3d8-d8ef-128c-371059317f73",
"ExternalReference": "AD123",
"Date": "2020-02-03",
"Items": [
{
"SKU": "1dfb18fa-3c84-4d31-8a3c-050c1d72a10b",
"Quantity": 2
}
],
"Outlet": "mag",
"Type": "out",
"OutType: "returnsupplier",
"Action": "start"
}
],
"status": true,
"time": "00:00:00.1726942"
}
HasNextItems Boolean Notes:
If true, any data in next page

If false, all data has been retrieved
InventoryAdjustments List of Inventory Adjustments List of Inventory Adjustments response
InventoryAdjustments
By String Account that changes inventory
TransferId String
Id String Activity inventory adjustment ID
Reference String Transfer reference
ExternalReference String Transfer external reference
Date String
Items List of Items List of Items response
Outlet String
SourceOutlet String The outlet that makes transfer
DestinationOutlet String The outlet receiving transfer
SourceSupplier String The supplier who supply goods
DestinationSupplier String The supplier who receive the reject goods
Type String Value:
in = Additional goods from supplier

out = Expenditure of goods to other outlets or to supplier
adjustment = Stock adjustment
opname = Stock comparison between store and warehouse
OutType String If Type is not out, value is null

If Type is out, value is:
returnsupplier
tooutlet
Action String Value:
accept = Action that approves the addition of stock items in your outlet
start = Action that reduces items in your outlet
adjustment = Stock adjustment
opname = Stock comparison between store and warehouse
Items (Action = Accept)

Only appear if Action = Accept
SKU String SKU must be unique
AcceptedQuantity Int Quantity of accepted products
RejectedQuantity Int Quantity of rejected products
CancelledQuantity Int Quantity of cancelled products
BuyingPrice Decimal Buying price input from transfer in
Items (Action = Start / Adjustment / Opname)
Only appear if Action = Start / Adjustment / Opname
SKU String SKU must be unique
Quantity Int Quantity of product has start / adjustment / opname
https://<API URL>/api/v3/GetOutletInventories
Call this API to get outlet inventories.
Parameters
outlet_code String N Unique identifier of the outlet
page_size Int N The quantity of data to be retrieved
page Int N The page to which quantity of data will be retrieved
Sample Usage
Response
{
"inventory_list": [
{
"sku": "GRSLD001",
"unit_in_stock": 41.0,
"product_id": "acb0571f-9762-423c-a261-4a7b1a8488a6",
"outlet_code": "mo"
},
{
"sku": "",
"unit_in_stock": -1.0,
"product_id": "cc4e7568-2337-4683-8894-fd0fd34c1b3c",
"outlet_code": "mo"
},
{
"sku": "",
"product_id": "1dfb18fa-3c84-4d31-8a3c-050c1d72a10b",
"outlet_code": "mo"
},
{
"sku": "8231712373217",
"product_id": "90d8c9fd-1c1d-4592-8a0b-a99c6b1c3c04",
"outlet_code": "mo"
},
{
"sku": "",
"product_id": "749e8eb1-04b4-4338-afcc-6a39652945fe",
"outlet_code": "mo"
},
{
"sku": "",
"product_id": "7d1ae631-29b7-4e54-893c-173dbdb90f4b",
"outlet_code": "mo"
},
{
"sku": "390441011",
"unit_in_stock": -1.0,
"product_id": "1dc719e5-47f9-49b4-bd63-4aae441e7441",
"outlet_code": "mo"
},
{
"sku": "CS001",
"product_id": "25ea9675-6c94-4d20-b18c-c5fa5c5bfe93",
"outlet_code": "mo"
},
{
"sku": "56421004",
"product_id": "6b3fe843-55d9-4bcc-9488-843044d9ab08",
"outlet_code": "mo"
},
{
"sku": "DP001",
"product_id": "c35caa68-3e2d-483a-ab50-35678de3d7dc",
"outlet_code": "mo"
}
],
"status": true,
"time": "00:00:00.0913431"
}
inventory_list List of Object (Inventory List)
error_message String System error message when error occurred during process
status Bool Status of the request, false means there's an error during the execution process
time String The processing time
InventoryList
sku String SKU of the product
unit_in_stock Double Current product quantity of the outlet
product_id String Unique identifier of the product
outlet_code String Accordance with the outlet code in iSeller
GetCustomers
https://<API URL>/api/v3/GetCustomers
Call this API to get customers data master.
Parameter
modified_after String N Limits the returned customers to those modified after or on the specified date, given ISO 8601 date format. (e.g
2020-11-20T10:00:00) without the time zone info
includes String Y CustomerAddresses
Sample Usage
Response
{
"customer_list": [
{
"id": "2db4da92-b998-459a-90c6-dd1389e2a382",
"external_customer_id": "william@iseller.id",
"fullname": "William Wijaya",
"email": "william@iseller.id",
"phone": "+6281264787186",
"date_of_birth": null,
"gender": "",
"credit_limit": null,
"store_credit": null,
"loyalty_points": 0,
"account_balance": null,
"customer_addresses": [
{
"address_id": "dc10d378-4b91-4cb1-aded-beb9e6c069e0",
"title": "",
"address": "Jln bentengan jaya 1 rt011 rw03 no 27",
"additional_address": "apt",
"city": "Jakarta Utara",
"country": "Indonesia",
"country_code": "ID",
"first_name": null,
"last_name": null,
"phone": "+6281264787186",
"is_default": false,
"is_deleted": false,
"modified_date": "2021-01-14 04:54:55",
"state": "Jakarta",
"zip": "14350"
}
],
"modified_date": "2021-01-14 04:54:55"
},
{
"id": "42f0fb01-4f68-4835-bf3f-ee373bb61cd2",
"external_customer_id": "john@doe.com",
"fullname": "John Doe",
"email": "john@doe.com",
"phone": "+628999059464",
"gender": "",
"loyalty_points": 1,
{
"address_id": "58ce3700-c827-40b6-9ce7-24e13beb2656",
"title": "",
"address": "Kirana Two Office Tower, Jalan Boulevard Timur, RT.5/RW.2, East
Kelapa Gading, North Jakarta City, Jakarta, Indonesia",
"additional_address": "",
"first_name": null,
"last_name": null,
"phone": "+628999059464",
"modified_date": "2020-11-13 05:14:11",
"state": "Jakarta",
"zip": "14110"
}
],
"modified_date": "2020-11-30 03:13:06"
},
{
"id": "e35d9e1e-a19c-4c7f-bebe-fed0d889eba1",
"external_customer_id": "CST001",
"fullname": "Jacob Lucas",
"email": "jacob@iseller.id",
"phone": "+6281264787186",
"gender": "",
"loyalty_points": null,
{
"address_id": "fcbd0c0e-f3db-4a6f-8eac-3976245200ac",
"title": "",
"address": "Jalan Sunter Agung Utara I, RT.4/RW.18, Sunter Agung, North
Jakarta City, Jakarta, Indonesia",
"additional_address": "apt",
"first_name": null,
"last_name": null,
"phone": "+6281264787186",
"modified_date": "2021-03-03 03:57:14",
"state": "Jakarta",
"zip": "14110"
}
],
"modified_date": "2021-03-03 03:57:14"
}
],
"status": true,
"time": "00:00:00.3066442"
}
customer_list List of Object (Customer List)
CustomerList
id String
external_customer_id String
fullname String
email String
phone String
date_of_birth String
gender String
credit_limit Double The maximum amount of customer's debt
store_credit Double Obtained when the customer makes a refund
loyalty_points Double
account_balance Double The remaining balance of customer's debt
customer_addresses List of Object (Customer Addresses)
modified_date String
CustomerAddresses
address_id String
title String
address String
additional_address String
city String
country String
country_code String
first_name String
last_name String
phone String
is_default Boolean
is_deleted Boolean
state String
zip String
GetStoreInfo
https://<API URL>/api/v3/GetStoreInfo
Call this API to get store info such as.
Store general info

Active outlets
Active payment types.
Sample Usage
Response
{
"store_info": {
"active_outlets": [
{
"outlet_id": "68178fff-53d1-4e58-9aee-03967cc9e912",
"outlet_code": "mag",
"outlet_name": "MAG",
"phone": "",
"address": "Boulevard Artha Gading",
"contact_name": "Anezka / Sebastian",
"email": "anezka.ayasha@gmail.com"
},
{
"outlet_id": "c4b9e388-91e2-d2e0-8995-2bd5423f03af",
"outlet_code": "okg",
"outlet_name": "Outlet Kelapa Gading",
"phone": "081818181",
"address": "Jln Sunter",
"contact_name": "William",
"email": "william@gmail.com"
},
{
"outlet_id": "31b29527-f54c-4004-b483-38b6a241c963",
"outlet_code": "mo",
"outlet_name": "Main Outlet",
"phone": "0123-778899",
"address": "Boulevard Artha Gading Blok A6B",
"contact_name": "Lucas George",
"email": "klassix@iseller.io"
},
{
"outlet_id": "457cf82d-a9ce-4c40-b7e5-7246e6920264",
"outlet_code": "Main Outlet2",
"outlet_name": "Main Outlet2",
"phone": "",
"address": "",
},
{
"outlet_id": "3373af24-dc6a-4a94-b2f2-925ef57c6585",
"outlet_code": "Outlet Sunter",
"outlet_name": "Outlet Sunter",
"phone": "",
"address": "alamat mkg",
},
{
"outlet_id": "23998296-808e-628f-3bda-a29be358192e",
"outlet_code": "Outlet MT Haryono",
"outlet_name": "Outlet MT Haryono",
"phone": "081818181881",
"address": "jalan kelapa gading",
"contact_name": "william",
"email": "william123@gmail.com"
},
{
"outlet_id": "60911d14-253a-a7b5-1d32-a388b96fed44",
"outlet_code": "Outlet Sudirman",
"outlet_name": "Outlet Sudirman",
"phone": null,
"address": "Jl. Jend. Sudirman",
"contact_name": "Wiko",
"email": "wiko@sleekr.co"
}
],
"active_payments": [
{
"name": "Cash",
"is_active": true,
"gateway": "cash",
"channel": "pos"
},
{
"name": "Cash",
"is_active": true,
"gateway": "cash",
"channel": "web"
},
{
"name": "VISA",
"is_active": true,
"gateway": "external_credit",
"channel": "pos"
},
{
"name": "BNI",
"is_active": true,
"gateway": "external_debit",
"channel": "pos"
},
{
"name": "BCA",
"is_active": true,
"channel": "pos"
},
{
"name": "OCBC",
"is_active": true,
"channel": "pos"
},
{
"name": "Gift Card",
"is_active": true,
"gateway": "gift_card",
"channel": "pos"
},
{
"name": "GO-PAY",
"is_active": true,
"gateway": "iseller_pay",
"channel": "pos"
},
{
"name": "OVO",
"is_active": true,
"channel": "pos"
},
{
"name": "DANA",
"is_active": true,
"channel": "pos"
},
{
"name": "LinkAja!",
"is_active": true,
"channel": "pos"
},
{
"name": "VISA, MasterCard, Debit cards",
"is_active": true,
"channel": "pos"
},
{
"name": "ISellerPay",
"is_active": true,
"channel": "web"
},
{
"name": "Loyalty Point",
"is_active": true,
"gateway": "points",
"channel": "pos"
},
{
"name": "Ultra Voucher",
"is_active": true,
"gateway": "ultra_voucher",
"channel": "pos"
}
],
"store_name": "Klassix",
"phone": "0123-778899",
"address": "Sky Street #1",
"email": "klassix.cs@iseller.io",
"currency": "IDR"
},
"status": true,
"time": "00:00:00.3906377"
}
store_info List of Object (Store Info) Store Info
status Boolean Status of the request, false means there's an error during the execution process
StoreInfo
active_outlets List of Object (Outlet) List of active outlets
active_payments List of Object (PaymentType) List of active payments
store_name String Name of store
phone String Phone Number
address String Address detail
email String Email associated to this store
currency String Currency to this store
Outlet
outlet_id Guid UniqueIdentifier of the outlet
outlet_code String Accordance with the outlet code in iSeller
outlet_name String Name of the outlet
phone String Phone number
address String Address detail
contact_name String Name of contact person associated to this outlet
email String Email associated to this outlet
PaymentType
name String Name of payment type
is_active Boolean Status of the payment type
gateway String Gateway used for the payment type
channel String Channel of the payment type

CancelOrder
https://<API URL>/api/v3/CancelOrder
Call this API to cancel order.
Parameters
order_id String N The Order ID to be canceled
reason String N The reason why the order was canceled
cancel_method String N The cancel method
Value:
payment_gateway
discount
discount_code String Y The discount code for canceled order
Sample Usage
Response
{
"code": null,
"notification_status": "refunded",
"order_id": "bcdf65ee-f260-45ea-94a6-16ca84b51c75",
"order_reference": "#1531",
"payment_type_name": "OVO",
"channel": "web",
"order_date": "2020-10-06 10:16:14",
"refund_date": "2020-10-06 10:17:48",
"refund_status": "refunded",
"refund_amount": 100.0000,
"sale_amount": 100.0000,
"shipment_integration": false,
"shipping_service_code": null,
"shipping_amount": 15000.0000,
"discount_code": null,
"refund_details": [
{
"product_id": "0dda5c38-daf6-4093-9f28-a567bdcc60bf",
"product_name": "Air Jordan 1 Retro Low",
"sku": "AIR001",
"quantity_order": 1,
"quantity_refund": 1.0,
"stock_before": 964.0,
"stock_after": 965.0,
"sell_price": 100.0000,
"buy_price": 5000000.0
}
],
"status": true,
"time": "00:00:16.5625576"
}
code String Partner transaction ID
notification_status String The notification status
order_id Guid The canceled order ID
order_reference String The canceled order reference
payment_type_name String Name of the payment type
channel String Order channel that indicates from which channel this order is created (e.g pos if created
from Point of Sales and web if created from Online Store)
order_date DateTime Date and time when the order was placed
refund_date DateTime Refund date for this refunded order
refund_status String Order refund status
refund_amount Decimal Refund amount for this canceled order
sale_amount Double Sale amount for this order (base price / gross amount).
shipment_integration Bool A value that indicates whether the product associated to this refund order does shipment integration
shipping_service_code String The service code of the integration shipment is used for the order
If value is null, so order that they used manual shipping
shipping_amount Decimal The shipping amount of this canceled order
discount_code String The discount code for canceled order
Automatic generated if you leave it blank at the time of request
status Boolean Status of the request, false means there's an error during the execution process
Refund Details
product_id Guid UniqueIdentifier of the product associated to this refund details.
product_name String Product name that associated to this refund details.
sku String SKU of the product that associated to this refund details.
quantity_order Integer Total quantity of the order.
quantity_refund Integer Total quantity of the refund details.
stock_before Integer Stock of the product before this refund.
stock_after Integer Stock of the product after this refund.
sell_price Decimal The selling price of this refund details.
buy_price Decimal The buying price of this refund details.
CreateCustomer
https://<API URL>/api/v3/CreateCustomer
Call this API to create customers on iSeller.
Parameter
id String N Customer's external ID

Unique per customer
first_name String N Customer's first name
last_name String Y Customer's last name
email String N Customer's email
phone String N Customer's phone number with country code
Format:
+628xxxxxxxxx
date_of_birth String Y Customer's date of birth
Format:
yyyy-mm-dd
gender String Y Customer's gender
Value:
M
F
address_title String Y Customer's address title
address String Y Customer's address
address_first_name String Y Customer's address first name
address_last_name String Y Customer's address last name
address_phone String Y Customer's address phone number
additional_address String Y Customer's additional address
city String Y Customer's city
state String Y Customer's state
country_code String Y Customer's ISO country code
country String Y Customer's country
zip String Y Customer's zip
Sample Usage
Response
{
"data": {
"customer_id": "42a900a8-8484-45a3-819c-f7e8643aa087",
"date_of_birth": "1995-12-01",
"id": "CUST001",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"phone": "+6289990594644",
"gender": "M",
"default_address_id": "85baa2f8-9c69-4d06-af79-d50c89876c6d",
"address": "Kirana Two Office Tower, Jl. Boulevard Timur No.88",
"address_first_name": "John",
"address_last_name": "Doe",
"address_phone": "+62812345678",
"additional_address": "Tunggu di lobby",
"address_title": "Office",
"state": "Jakarta",
"zip": "14240"
},
"status": true,
"time": "00:00:00"
}
data List of Customer List of Customer response
Customer
customer_id Guid iSeller customer's ID
id String
first_name String
last_name String
email String
phone String
gender String
default_address_id String
address String
address_first_name String
address_last_name String
address_phone String
address_title String
city String
state String
country_code String
country String
zip String
UpdateCustomer
https://<API URL>/api/v3/UpdateCustomer
Call this API to update customers data on iSeller.
Parameter
customer_id Guid N iSeller customer's ID
Notes:
This parameter will be optional if id is not empty
id String N Customer's external ID
Notes:
This parameter will be optional if customer_id is not empty
first_name String Y Customer's first name
last_name String Y Customer's last name
email String Y Customer's email
phone String Y Customer's phone number with country code
Format:
+628xxxxxxxxx
gender String Y Customer's gender
Value:
M
F
address_title String Y Customer's address title
address String Y Customer's address
Notes:
Required if you want update the address data (address_title, address_first_name, etc)
address_first_name String Y Customer's address first name

address_last_name String Y Customer's address last name
address_phone String Y Customer's address phone number
additional_address String Y Customer's additional address
city String Y Customer's city
state String Y Customer's state
country_code String Y Customer's ISO country code
country String Y Customer's country
zip String Y Customer's zip
Notes:
Required if you want update the address data (address_title, address_first_name, etc)
Sample Usage
Response
{
"data": {
"customer_id": "42a900a8-8484-45a3-819c-f7e8643aa087",
"id": "CUST001",
"last_name": "Thor",
"email": "john.doe001@gmail.com",
"phone": "+6289990594645",
"gender": "M",
"default_address_id": "85baa2f8-9c69-4d06-af79-d50c89876c6d",
"address_first_name": "John",
"address_last_name": "Doe",
"address_phone": "+628989898989",
"address_title": "Office",
"state": "Jakarta",
"zip": "14240"
},
"status": true,
"time": "00:00:00"
}
data List of Customer List of Customer response
Customer
customer_id Guid iSeller customer's ID
id String
first_name String
last_name String
email String
phone String
gender String
default_address_id String
address String
address_first_name String
address_last_name String
address_phone String
address_title String
city String
state String
country_code String
country String
zip String
GetCustomer
https://<API URL>/api/v3/GetCustomer
Call this API to get specific customer data.
Parameter
customer_id String N iSeller customer's ID
external_customer_id String N Customer's external ID
includes String Y CustomerAddresses
Sample Usage
Response
{
"customer_list": [
{
"id": "5959e2d9-5f8a-4595-94c8-1245402285e0",
"external_customer_id": "CUST01010",
"fullname": "Rexus Rexus",
"email": "john.doe1010@gmail.com",
"phone": "+628999051010",
"date_of_birth": "1995-12-01 00:00:00",
"gender": "M",
"loyalty_points": null,
{
"address_id": "c5566b68-3566-4195-8fea-076001906f07",
"title": "Office",
"city": "Jakarta Pusat",
"first_name": John,
"last_name": Doe,
"phone": "+628999051010",
"is_default": true,
"modified_date": "2021-03-19 02:53:19",
"state": "Jakarta ",
"zip": "10750"
},
{
"address_id": "545c5e3a-002c-e46c-ced1-2fb97c6b8892",
"title": "Office 2",
"address": "Jl. M.H. Thamrin No.57, RT.9/RW.5, Gondangdia, Kec.
Menteng, Kota Jakarta Pusat, Daerah Khusus Ibukota Jakarta 10350",
"additional_address": "Plaza Permata",
"first_name": John,
"last_name": Doe,
"phone": "+628999051010",
"modified_date": "2021-03-19 02:48:39",
"state": "Jakarta",
"zip": "10350"
}
],
"modified_date": "2021-03-18 08:38:03"
}
],
"status": true,
"time": "00:00:00.0664096"
}
customer_list List of Object (Customer)
CustomerList
id String iSeller customer's ID
external_customer_id String Customer's external ID
fullname String
email String
phone String
gender String
credit_limit Double The maximum amount of customer's debt
store_credit Double Obtained when the customer makes a refund
loyalty_points Double
account_balance Double The remaining balance of customer's debt
customer_addresses List of Object (Customer Addresses)
CustomerAddresses
address_id String iSeller address ID
title String
address String
city String
country String
country_code String
first_name String
last_name String
phone String
is_default Boolean
is_deleted Boolean
state String
zip String
UpdateCustomerAddresses
https://<API URL>/api/v3/UpdateCustomerAddresses
Call this API to update specific customer address data.
Parameter
customer_id String N iSeller customer ID
addresses List of Object (Addresses) N
Addresses
title String Customer's address title
address String Customer's address
Notes:
Required if you want update the address data (city, country_code, country, state)
additional_address String Customer's additional address
city String Customer's city
country String Customer's country
country_code String Customer's ISO count code
first_name String Customer's address first name
last_name String Customer's address last name
phone String Customer's address phone number
is_default Boolean Customer's default address
state String Customer's state
zip String Customer's zip
Notes:
Required if you want update the address data (city, country_code, country, state)
Sample Usage
Response
{
"customer_id": "7518250f-a88b-4da5-bc22-779c385144c8",
"addresses": [
{
"address_id": "c5566b68-3566-4195-8fea-076001906f07",
"title": "Office",
"address": "Jl. Boulevard Bar. Raya C No.6-7, RT.2/RW.9, Klp. Gading Bar.,
Kec. Klp. Gading, Kota Jkt Utara, Daerah Khusus Ibukota Jakarta 14240",
"last_name": "Doe",
"is_default": true,
"modified_date": "2021-03-19 06:26:39",
"state": "Jakarta",
"zip": "14240"
}
],
"status": true,
"time": "00:00:00"
}
customer_id String iSeller customer ID
addresses List of Object (Addresses)
Addresses
title String
address String
city String
country String
country_code String
first_name String
last_name String
phone String
is_default Boolean
is_deleted Boolean
state String
zip String
AddCustomerAddresses
https://<API URL>/api/v3/AddCustomerAddresses
Call this API to add customer address data.
Parameter
addresses List of Object (Addresses) N
Addresses

address String
first_name String
last_name String
title String
phone String
city String
country String
country_code String
state String
zip String
Sample Usage
Response
{
"customer_id": "14164cca-1046-4322-b237-1d6c1787ca92",
"addresses": [
{
"address_id": "699a91ac-a586-4ed9-a8f8-fe9b9c032ef7",
"title": "Office MidPlaza",
"address": "Jl. Jend. Sudirman No.Kav. 10-11, RT.10/RW.11, Karet Tengsin,
Kecamatan Tanah Abang, Kota Jakarta Pusat, Daerah Khusus Ibukota Jakarta 10220",
"additional_address": "MidPlaza MidPlaza",
"first_name": "Mid",
"last_name": "Plaza",
"phone": "+62215737777",
"modified_date": "2021-03-24 02:32:17",
"state": "Jakarta",
"zip": "10220"
}
],
"status": true,
"time": "00:00:00"
}
addresses List of Object (Addresses)
Addresses
title String
address String
city String
country String
country_code String
first_name String
last_name String
phone String
is_default Boolean
is_deleted Boolean
state String
zip String
DeleteCustomerAddresses
https://<API URL>/api/v3/DeleteCustomerAddresses
Call this API to delete customer address.
Parameter
address_ids String N Customer's address id
Sample Usage
Response
{
"customer_id": "f755dbf2-b72a-4918-b18d-497b93ebe5aa",
"address_ids": [
"c8342846-c749-0416-bc9a-5eb732322f22a"
],
"status": true,
"time": "00:00:00"
}
address_ids String
if want to apply to all outlet visibility, don't input the outlet visibility on request body

IPOS ERPAPIDocumentation 091121 0609 36028

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

IPOS ERPAPIDocumentation 091121 0609 36028

Uploaded by

Copyright:

Available Formats

ERP API Documentation

How to Access API

Add visibility and outlet_visibility on CreateProducts and UpdateProducts request body

Add product_type and vendor on CreateProducts and UpdateProducts request body

Add New API DeleteCustomerAddresses

Add New API AddCustomerAddresses

Add parameter includes for request on GetCustomers

Add CreateCustomer and UpdateCustomer API

Add information Source and Destination Outlet / Supplier on GetTransfer API

Add List of Object (OutletPrices) on CreateProducts and UpdateProducts API

Add CancelOrder's API

Add parameter transfer_type and out_type on GetTransfer API

Add parameter modified_after on GetCustomers

Adding new API

Add parameter TransferId on GetTransfer's API

Add parameter reference_code on CreateTransfer's API

How to Access API

1. Change the Authorization Type to OAuth 2.0

2. Set Add token to Header

3. Create new access token by clicking Get New Access Token

4. Specify request token info, then click request token

Grant Type Client Credentials

Access Token Url https://isellershop.com/oauth/token

For development, the <API URL> is <storename>.iseller.io

Call this API to create products.

Name Type Optional Description

products List of Object (Product) N List of products item

Name Type Optional Description

sku String N SKU must be unique

type String N Value:

visibility String Y Value:

outlet_prices List of Object Optional

shipping_weight Decimal Y Required if require_shipping = true

shipping_unit String Y Required if require_shipping = true

variants List of Object (Variant) Optional Required if type = variant

composite List of Object Optional Required if type = composite

comboset List of Object (Comboset) Optional Required if type = comboset

Name Type Optional Description

Name Type Optional Description

Name Type Optional Description

category String N Product's comboset category

Sample Usage (Type = Standard)

Sample Usage (Type = Variant)

Name Type Description

products List of Product List of Product response

error_message String The error message of the response

status Boolean The response status

time String The response time

Name Type Description

error_message String Created product error message

is_success Boolean Created product status

Call this API to update products.

Name Type Optional Description

products List of Object (Product) N List of products item

sku String N SKU must be unique

type String N Value:

visibility String Y Value:

outlet_visibility String Y The outlet visibility only applies if visibility is POS.

outlet_prices List of Object Optional

shipping_weight Decimal Y Required if require_shipping = true

shipping_unit String Y Required if require_shipping = true

variants List of Object (Variant) Optional Required if type = variant

composite List of Object (Composite) Optional Required if type = composite

If null, make no changes to the composite data