35
Spesifikasi API Nomor Versi Tanggal Rilis 1.0 5 November 2013 1.1 11 November 2013 1.2 12 November 2013 1.3 13 November 2013 1.4 18 November 2013 1.5 19 November 2013 1.6 28 November 2013 1.7 17 Desember 2013 1.8 19 Desember 2013 1.9 27 Desember 2013 1.10 13 Januari 2013 1.11 4 Maret 2014 1.12 10 Maret 2014 1.13 13 Mei 2014 1.14 25 Agustus 2015 1.15 3 Desember 2015 1.16 8 Desember 2015

Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

  • Upload
    lamkiet

  • View
    226

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Spesifikasi API

Nomor Versi Tanggal Rilis

1.0 5 November 2013

1.1 11 November 2013

1.2 12 November 2013

1.3 13 November 2013

1.4 18 November 2013

1.5 19 November 2013

1.6 28 November 2013

1.7 17 Desember 2013

1.8 19 Desember 2013

1.9 27 Desember 2013

1.10 13 Januari 2013

1.11 4 Maret 2014

1.12 10 Maret 2014

1.13 13 Mei 2014

1.14 25 Agustus 2015

1.15 3 Desember 2015

1.16 8 Desember 2015

Page 2: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Memulai Penggunaan

Untuk memulai menggunakan Product API elevenia, ikuti langkah-langkah dibawah ini:

1. Mendaftar sebagai Seller:

Sebelum memulai untuk menggunakan Open API, developer harus mendaftarkan dirinya sebagai

seller dan mengisi dokumen yang dibutuhkan (mengacu pada pendftaran sebagai Seller Individu ,

Bisnis Seller atau Global Seller) sebagai prasyarat. Setelah melakukan pendaftaran, mohon untuk

mengecek email anda dan klik link konfirmasi. Seller harus menunggu persetujuan sebagai valid

seller oleh elevenia (persetujuan akan memakan waktu maksimal sampai 1x24 jam). Ketika akun

anda sudah siap digunakan, elevenia akan mengirimkan notifikasi melalui email.

2. Mendapatkan API Key

Ketika developer sudah melakukan registrasi dan persetujuan sebagai seller, developer akan

mendapatkan API Key. API Key harus dirahasiakan oleh developer dan digunakan sebagai

permintaan autentikasi ke elevenia Open API.

Untuk mendapatkan API key, anda harus log in ke halaman Seller Office elevenia

(http://soffice.elevenia.co.id/login.do). Menuju menu “Seller Information” / ”Pengaturan

Informasi Penjual”. API key terletak di bawah halaman (mengacu pada gambar dibawah ini).

Page 3: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

3. Membuat Profil Pengiriman

Sebelum melakukan pendaftaran produk, anda perlu mendefinisikan profil pengiriman. Profil

pengiriman adalah profil alamat darimana anda mengirimkan produk ke Buyer. Anda perlu

Page 4: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

mendefinisikan metode pengiriman, aturan pengiriman, dan area pengiriman yang tidak

dijangkau oleh anda. Profil pengiriman digunakan untuk menghitung biaya pengiriman.

Untuk mendaftarkan profil pengiriman, log in di seller office (mengacu pada langkah 2 tentang

bagaimana log in di seller office) , menuju menu “Product Information Template Management” /

”Pengaturan template Informasi Produk”, lalu klik tombol “Delivery Template Registration” /

”Registrasi Profil Pengiriman.

Di bawah ini merupakan halaman tatap muka dari halaman registrasi profil pengiriman

Anda harus memberikan nama untuk profil pengiriman dengan jelas untuk menghindari

kebingungan. Contoh, anda ingin membuat pelayanan pengiriman untuk TIKI & JNE di seluruh

provinsi yang ada di Indonesia, anda dapat memberikan nama “TIKI & JNE semua provinsi” atau

“TIKI & JNE layanan regular semua provinsi”.

Anda juga harus mendefinisikan alamat asal (alamat gudang atau alamat toko) dari menu

dropdown. Alamat yang pertama kali muncul merupakan alamat ketika anda mendaftarkan toko

anda di elevenia untuk pertama kali. Anda juga dapat menambahkan alamat jika anda memiliki

beberapa cabang atau gudang yang memiliki alamat yang berbeda dengan alamat toko anda.

Page 5: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Anda juga dapat menentukan alamat pengirim. Alamat pengirim adalah lokasi dimana buyer anda

harus mengembalikan produk dengan kasus produk tidak sesuai dengan ekspektasi, kualitas

buruk dan perlu ditukar.

Anda dapat menambahkan hingga maksimal 40 profil pengiriman.

Setelah itu, anda pasti akan mendapatkan nomer profil pengiriman sebagai referensi ketika anda

mendaftarkan / mengupload produk menggunakan elevenia API.

Page 6: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Ketika mengirim produk menggunakan API, xml akan berubah menjadi label tmpltSeq :

Mengacu pada bagian Upload Product (Insert Product) dokumen ini tentang bagaimana

mendaftarkan produk.

4. Memanfaatkan Produk API elevenia

Setelah langkah 1 dan 2 selesai, developer sudah dapat memanfaatkan elevenia Open API.

Terdapat dua server API, development (sandbox) untuk lingkungan testing dan yang lain adalah di

lingkungan live (production).

Testing Server : [hubungi kami untuk mendapatkan testing environment]

Production Server : http://api.elevenia.co.id/rest

Authentication

Setiap permintaan ke elevenia Open API membutuhkan header autentikasi. Termasuk Open API Key di

header dari http untuk elevenia API.

Contoh:

Kesalahan Autentikasi

Output Description

Nama Elemen Tipe Data Deskripsi

resultCode Numeric Result code:

100 = Missing Open API Key in request

header.

200 = Open API Key is invalid and not

corresponds to any user.

300 = Seller has not been approved.

Page 7: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

resultMessage String Authentication error message

API Resource Endpoint

Melihat Daftar Kategori

Method Type : GET

Parameter : ­

Message Type : ­

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/cateservice/category

Output Description

Endpoint ini akan mengembalikan xml dari list kategori yang lengkap dengan elemen xml berikut.

Nama Elemen Tipe Data Deskripsi

ns2:category - Category(Node)

depth Number Depth of Tree structure. Elevenia has 3 level of

category.

dispNm String Category Name

dispNo Number Category ID

parentDispNo Number Super ordinate Category ID

Contoh Output:

Page 8: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Melihat sub-kategori berdasarkan ID Kategori Utama

Method Type : GET

Parameter : PathParam

Message Type : String(Number)

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/cateservice/category/dispCtgrNo

Input Description

Nama Element Tipe Data Mandatory Panjang Maksimal Deskripsi

dispCtgrNo Number Y ? Parameter Category ID

provided in the URL

Contoh Input

1. HTTP Request

http://api.elevenia.co.id/rest/cateservice/category/1

2. XML Data:

No XML Data

Page 9: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Output Description

Output XML dari daftar sub-category akan dikembalikan dengan unsur-unsur berikut.

Nama Elemen Tipe Data Deskripsi

ns2:category - Category(Node)

depth Number Depth of Tree Structure. Elevenia has 3 level of

category

dispNm String Category Name

dispNo Number Category ID

parentDispNo Number Super ordinate Category ID

Melihat Atribut Kategori berdasarkan ID Kategori

Method Type : GET

Parameter : PathParam

Message Type : String(Number)

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/cateservice/categoryAttributes/dispCtgrNo

Input Description

Nama Element Tipe Data Mandatory Panjang Maksimal Deskripsi

dispCtgrNo Number Y ? Parameter Category ID

provided in the URL

Contoh Input

1. HTTP Request

http://api.elevenia.co.id/rest/cateservice/category/Attributes/138

2. XML Data:

No XML Data

Output Description

Output XML dari daftar sub-category akan dikembalikan dengan unsur-unsur berikut.

Nama Elemen Tipe Data Deskripsi

ns2:product

CategoryAttribute - Product Category(Node)

prdAttrCode Number Category Attribute Code

Page 10: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

prdAttrNm String Category Attribute Name

prdAttrNo Number Category Attribute ID

Contoh Output:

Melihat daftar Template Pengiriman

Method Type : GET

Parameter : PathParam

Message Type : String(Number)

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/delivery/template

Input Description

Tidak ada input yang dibutuhkan

HTTP Request:

http://api.elevenia.co.id/rest/delivery/template

Output Description

Output XML dari daftar sub-kategori akan dikembalikan dengan unsur-unsur berikut.

Nama Elemen Tipe Data Deskripsi

dlvTmpltNm String Delivery template name

dlvTmpltSeq String

Delivery template number

This number will be used for registering product

Using xml tag:

<tmpltSeq>DLV_NUMBER</tmpltseq

Page 11: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Contoh Output:

1. Berhasil

2. Gagal

Upload Produk (Memasukkan Product)

Method Type : POST

Parameter : XML

Message Type : XML/String

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/prodservices/product

Input Description

Klien harus mengirimkan setiap item file XML yang akan didaftarkan di elevenia dengan unsur-unsur

berikut:

Page 12: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Nama Elemen Tipe Data Mandatory

Y/N

Panjang Maks Deskripsi

selMnbdNckNm String Y ? Nickname

selMthdCd String

(Number) Y ?

Sales Type.

‘01’: Ready Stock

‘04’: Pre­Order

‘05’: Used Items

dispCtgrNo Number Y ? Category ID

ProductCtgrAttribute - - - Category attribute (Parent

Node)

prdAttrCd

prdAttrNm

prdAttrNo

prdAttrVa

Number

String

String

String

Y

Y

Y

Y

?

Category attribute code

Category attribute name

i.e: brand, model, type, ISBN

(for books)

Category attribute ID

Category attribute value i.e:

samsung, galaxy, s3,

EAN­123123123123

prdTypCd Number N ? Service Type

prdNm String Y ? Item Name

prdStatCd String

(Number) Y ?

Item Conditions.

‘01’: New

‘02’: Used

useMon Number N ? Period of use (If the product is

a second product)

paidSelPrc Number N ? Sales Price at purchased time

(for used item only)

Page 13: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

exteriorSpecialNote String N ?

The current items conditions

e.g: scratches (for used items

only)

prdWght Number Y ? Item weight in kilogram

dlvGrntYn String Y ?

Guarantee of delivery. The

value is Y/N. If set as Y, seller

is responsible to any damage

happens during delivery.

minorSelCnYn String Y ?

Minors can buy (Under 17

years old). If set as N, no

image is displayed to guest

user and user under than 17

years old.

suplDtyfrPrdClfCd String Y ?

VAT/Tax Item Code.

01 = Barang Kena Pajak

02 = Barang Bebas Pajak

* Default value is 01

prdImage01

prdImage02

prdImage03

prdImage04

prdImage05

prdImage01Src

String

String

String

String

String

String

Y

N

N

N

N

N

?

Main(Representative) Image

URL

Additional Image 1 URL

Additional Image 2 URL

Additional Image 3 URL

Additional Image 4 URL

Byte code of Image

htmlDetail String Y ? Item’s Detailed Description

(html format supported)

advrtStmt String N ?

Item’s advertisement

information. e.g: “Hot item’s of

this week”

orgnTypCd

orgnTypDtlsCd

orgnNmVal

orgnCountry

String

(Number)

String

­

String

N

­

N

N

?

Code of Country of Origin

코드

Regional Code of Country of

Origin

Name of Country of Origin

Country of Origin

Page 14: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

sellerPrdCd String N ? Seller’s Item/Product Code (SKU)

bcktExYn String N ?

Restriction of storing in Cart. If

set to Y, the purchase of this

product should be paid

immediately, can’t be

combined with other items.

ProductCert

certTypeCd

certKey

­

String

(Number)

String

­

N

N

?

Authentication

Information(Node)

Type of Authentication

Authentication Number.

(ex: BPPOM number)

reviewDispYn String N ? Whether display the Item

Comments/Review or not

reviewOptDispYn String N ?

Enable/Disable the

Review/Comment in the

item’s page

selTermUseYn String ? Whether to use sales period

(Y/N)

selPrdClfCd String N ?

Sales Period Code.

3:101 = 3 days

5:102 = 5 days

7:103 = 7 days

15:104 = 15 days

30:105 = 30 days

60:106 = 60 days

90:107 = 90 days

120:108 = 120 days

0:100 = direct input,

This should be set to ‘Y’ for

pre­order item, and set the

pre­order period with

aplBgnDy and aplEndDy

aplBgnDy String N ?

Sales period (or Pre­Order)

Start Date

(MM/DD/YYYY)

Page 15: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

aplEndDy String N ? Sales period (or Pre­Order)

End Date (MM/DD/YYYY)

setFpSelTermYn String N ? Set Fixed Price Sales Period

selPrdClfFpCd String N ?

Sales Period Code. Set Fixed

Price Sales Period – include

this if selTermUseYn = ‘Y’

wrhsPlnDy String N ? Due date of Stock

selPrc Number Y ? Product’s price

prdSelQty Number Y ? Set the product stocks

cuponcheck String N ? Enable/Disable discount

program

dscAmtPercnt String

(Number) N ? Discount value

cupnDscMthdCd String

(Number) N ?

Discount unit code

01 = Rp (in rupiah)

02 = % (in percentage)

cupnUseLmtDyYn String N ? Limit the discount program (in

days)

cupnIssEndDy String N ? Discount program’s end date

mileageYN String N ? Enable/Disable token

giveaway

mileageValue String N ? Token value to give to buyer

after purchasing item

mileageWyCd String N ?

Token unit code

01 = Rp (in rupiah)

02 = % (in percentage)

Page 16: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

mileageSpplLmtQty String N ?

Limit the token giveaway after

reaching an amount of

treshold (by number of

purchase). Buyer won’t get

anymore token after a certain

number of purchase

pointYN String N ? Enable/Disable point giveaway

pointValue String N ? Point value to give to buyer

after purchasing item

spplWyCd String N ?

Point unit code

02 = Rp (in rupiah)

01 = % (in percentage)

pntSpplLmtQty String N ?

Limit the point giveaway after

reaching an amount of

treshold (by number of

purchase). Buyer won’t get

anymore point after a certain

number of purchase

optSelectYn String N ? Whether it is multi­choice or

not

txtColCnt String

(Number) N ? Fixed Data Value 1

prdExposeClfCd String

(Number) N ?

Product Details Order.

00: Order by Number

01: Order by Name

Alphabetical, Ascending (A­Z)

02: Order by Name

Alphabetical, Descending

(Z­A)

03: Order by Price, Desending

(Low to High)

04: Order by Price, Desending

(High to Low)

optionAllQty String

(Number) N ? Batch setting for quantity

optionAllAddPrc String

(Number) N ? Batch setting for price

Page 17: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

optionAllAddWght String

(Number) N ?

Batch setting for additional

weight

colTitle String N ? Option Name

ProductOption

colValue0

­

String

­

N ?

Item Option (Node)

Option Data Type

colCount

useYn

Number

String

N

N ?

Option of Amount of Stock

Used or New product (Y/N)

ProductCustOption

colOptName

colOptUseYn

­

String

String

­

N

N

?

Writable Option by

Buyer(Node)

Writable Name Option by

Buyer

Whether use Option or not

ProductComponent

addPrdGrpNm

compPrdNm

sellerAddPrdCd

addCompPrc

compPrdQty

compPrdVatCd

addUseYn

addPrdWght

­

String

String

String

Number

Number

String

(Number)

String

Number

­

N

N

N

N

N

N

N

N

?

Additional setting for Item

(Node)

Additional Item Name

Additional Item Data Type

Additional Item Number of

Sellers

Additional setting for Price

Amount of Sales

VAT

Status

Additional Weight setting

selMinLimitTypCd String

(Number) N ?

Minimum purchase quantity

code (see code reference)

selMinLimitQty Number N ? Amount of minimum purchase

quantity

selLimitTypCd String

(Number) N ?

Maximum purchase amount

code (see code reference)

selLimitQty Number N ? Amount of maximum

purchase quantity

useGiftYn String N ? Enable/Disable free gift

Page 18: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

ProductGift

giftInfo

giftNm

aplBgnDt

aplEndD

­

String

String

String

String

­

N

N

N

N

?

Free Gift information(Node)

Free Gift information

Free Gift Name

Start Date of Free Gift

program

End Date of Free Gift program

tmpltSeq Number ?

Number of Delivery

information Template Number.

Please refer to Getting

Started > Create Delivery

Template to get the Delivery

number information.

asDetail String Y ?

After service information.

Could be the address or

contact info of the after­sales

service.

rtngExchDetail String Y ? Return/Exchange information

Contoh Input (Produk Standar):

Page 19: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Item yang digunakan

Untuk item yang digunakan, tambahkan baris dibawah ini ke dalam input XML:

Contoh Kode di PHP

Page 20: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Output Description

Nama Elemen Tipe Data Deskripsi

productNo String Product ID

message String Result Message

resultCode String

Result code as follows:

200 = OK

500 = Error

Contoh Output:

1. Berhasil

2. Gagal

Update Produk

Method Type : GET

Parameter : PathParam

Message Type : String(Number)

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/prodservices/product

Input Description

Format XML sama seperti format Insert Product API, namun menggunakan tag tambahan :

Ouput Description

Page 21: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Endpoint ini akan kembali ke xml rincian produk dengan format yang sama seperti xml upload produk.

Melihat Detail Produk

Method Type : GET

Parameter : PathParam

Message Type : String(Number)

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/prodservices/product/details/prdNo

Output Description

Endpoint ini akan kembali ke xml rincian produk dengan format yang sama seperti xml upload produk.

Melihat Daftar Produk

Method Type : GET

Parameter : PathParam

Message Type : String(Number)

Returned Value : XML

API Key: REQUIRED

Request URL :

http://api.elevenia.co.id/rest/prodservices/product/listing?page=pageNumber

Output Description

Endpoint ini akan menampilkan daftar produk yang sudah diupload ke elevenia.

Edit Opsi Produk

Method Type : POST

Parameter : PathParam

Page 22: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Message Type : XML/String

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/prodservices/updateProductOption/prdNo

Input Description

Nama Elemen Tipe

Data

Mandatory

Y/N

Panjang Maks Deskripsi

prdNo String Y ? Item ID / Product ID provided in

the URL

optSelectYn String Y ? Whether Product Number is

required (Y is required)

txtColCnt String Y ? Fixed Value 1

prdExposeClfCd String Y ?

Product Details Order.

00: Order by Number

01: Order by

NameAlphabetical,

Ascending (A­Z)

02: Order by Name

Alphabetical,

Descending (Z­A)

03: Order by Price, Desending

(Low to High)

04: Order by Price, Desending

(High to Low)

optionAllQty String Y ? Batch Setting for amount of

stock

optionAllAddPrc String Y ? Batch Setting for price

optionAllAddWght String Y ? Batch setting for additional

weight

colTitle String Y ? Option Name

productOption

colValue0 String Y ?

Item Option (Node)

The option value

Page 23: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

colOptPrice

colCount

useYn

optWght

String

String

String

Y

Y

Y

Additional Price

Number

Status

Additional Weight

Contoh Input

1. HTTP Request:

http://api.elevenia.co.id/rest/prodservices/UpdateProductOption/4796523

2. XML Data;

Output Description

Jika proses ini berhasil, maka semua value yang diminta akan dikembalikan melalui respon, lainnya akan

dikembalikan dengan pesan gagal. Lihat contoh

Contoh Output

1. Berhasil

Page 24: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

2. Gagal

Merubah Harga Satuan

Method Type : GET

Parameter : PathParam

Message Type : String(Number)

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/prodservices/product/price/prdNo/selPrc

Input Description

Nama Elemen Tipe Data Mandatory

Y/N

Panjang Maks Deskripsi

prdNo String Y ? Item ID / Product ID

provided in URL.

selPrc String ? Sales Price (as a

parameter in URL)

Contoh Input

1. HTTP Request: http://api.elevenia.co.id/rest/prodservices/product/price/4796523/10000

2. XML Data:

Page 25: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

No XML Data

Output Description

Nama Elemen Tipe Data Deskripsi

productNo String Product ID

message String Result message

resultCode String

Result code as follows:

200 = OK

500 = Business Error

-1000 = Server is under maintenance

Contoh Output

1. Berhasil:

2. Gagal:

Merubah Diskon Satuan

Method Type : POST

Parameter : XML

Message Type : XML/String

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/prodservices/product/priceCoupon/prdNo

Input Description

Nama Elemen Tipe

Data

Mandatory

Y/N

Panjang

Maks

Deskripsi

Page 26: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

prdNo String Y ?

Item ID / Product ID

provided

in the URL

selPrc String Y ? Product Price

cuponcheck String Y ?

Whether these product

can

use a coupon or not

dscAmtPercnt String Y ? Discount value

cupnDscMthdCd String Y ?

Unit discount type

01 = Rp

02 = %

cupnUseLmtDyYn String Y ? Promotion period (Y/N)

cupnIssEndDy String Y ?

End date of promotion

period

(MM/DD/YYYY)

Contoh Input

1. HTTP Request:

http://api.elevenia.co.id/rest/prodservices/product/priceCoupon/4796523

2. XML Data:

Output Description

Nama Elemen Tipe Data Deskripsi

productNo String Product ID

Page 27: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Message String Result message

resultCode String

Result code as follows:

200 = OK

500 = Business Error

-1000 = Server is under maintenance

Contoh Output

1. Berhasil:

2. Gagal:

Melihat ProductStockNo Satuan

Method Type : GET

Parameter : ­

Message Type : ­

Returned Value : XML

API Key: REQUIRED

Request URL :

http://api.elevenia.co.id/rest/prodmarketservice/prodmarket/stck/prdNo

Input Description

Nama Elemen Tipe

Data

Mandatory

Y/N

Panjang

Maks

Deskripsi

prdNo Number Y ? Parameter Product ID

provided in the URL

Contoh Input

1. HTTP Request:

Page 28: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

http://api.elevenia.co.id/rest/prodmarketservice/prodmarket/stck/1

2. XML Data:

No XML Data

Output Description

Endpoint ini akan mengembalikan xml dari kategori daftar lengkap dengan elemen xml berikut

Nama Elemen Tipe Data Deskripsi

ProductStock

addPrc

mixDtlOptNm

optWght

prdNo

prdStckNo

prdStckStatCd

selQty

stckQty

­

Number

String

Number

Number

Number

String

Number

Number

ProductStock(Node)

Option price

Detail product options

Additional Weight

Product ID

Product Stock ID

Stock Status (01: Use; 02: Sold Out)

Product sale quantity

Product stock quantity

prdNm String Result message

prdNo Number Product ID

sellerPrdCd String Seller’s Product Code (SKU)

Contoh Output

Page 29: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Melihat ProductStockNo Lebih Dari Satu

Method Type :POST

Parameter : ­

Message Type : ­

Returned Value : XML

API Key: REQUIRED

Request URL :

http://api.elevenia.co.id/rest/prodmarketservice/prodmarket/stocks

Input Description

Nama Elemen Tipe

Data

Mandatory

Y/N

Panjang

Maks

Deskripsi

ProductStock

prdNo

­

Number

Y

Y ?

Product Stock Node

Product ID

Contoh Input

1. HTTP Request:

http://api.elevenia.co.id/rest/prodmarketservice/prodmarket/stocks

2. XML Data:

Output Description

Endpoint ini akan mengembalikan xml dari kategori daftar lengkap dengan elemen xml berikut

Nama Elemen Tipe Data Deskripsi

Page 30: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

ProductStock

addPrc

mixDtlOptNm

optWght

prdNo

prdStckNo

prdStckStatCd

selQty

stckQty

­

Number

String

Number

Number

Number

String

Number

Number

ProductStock(Node)

Option price

Detail product options

Additional Weight

Product ID

Product Stock ID

Stock Status (01: Use; 02: Sold Out)

Product sale quantity

Product stock quantity

prdNm String Result message

prdNo Number Product ID

sellerPrdCd String Seller’s Product Code (SKU)

Contoh Output

Page 31: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Merubah kuantiti produk (Update Stok)

Method Type : PUT

Parameter : PathParam/XML

Message Type : XML/String(Number)

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/prodservices/stockqty/prdStckNo

Input Description

Nama Elemen Tipe

Data

Mandatory

Y/N

Panjang

Maks

Deskripsi

prdStckNo String Y ? Stock ID, provided in the

URL

prdNo String Y ? Product/Item ID

prdStckNo String Y ? Stock ID

stckQty String Y ? Stock Quantity

optWght String Y ? Product/Item Weight in

kilograms

Contoh Input

1. HTTP Request:

http://api.elevenia.co.id/rest/prodservices/stockqty/434450294

2. XML Data:

Page 32: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Output Description

Nama Elemen Tipe Data Deskripsi

productNo String Product ID

message String Result message

resultCode String

Result code as follows:

200 = OK

500 = Business Error

-1000 = Server is under maintenance

Contoh Output

1. Berhasil:

2. Gagal:

Menyembunyikan produk (Merubah status produk ke ‘105’ - ‘Disembunyikan’)

Method Type : PUT

Parameter : PathParam

Message Type : String(Number)

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/prodstatservice/stat/stopdisplay/prdNo

Page 33: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Input Description

Nama Elemen Tipe

Data

Mandatory

Y/N

Panjang

Maks

Deskripsi

prdNo String Y ?

Parameter Product ID

provided in the

URL.

Contoh Input

1. HTTP Request:

http://api.elevenia.co.id/rest/prodstatservice/stat/stopdisplay/100

2. XML Data:

No XML Data

Output Description

Nama Elemen Tipe Data Deskripsi

message String Result message

resultCode String

Result code as follows:

200 = OK

500 = Business Error

-1000 = Server is under maintenance

Contoh Output

1. Berhasil:

2. Gagal:

Mengaktifkan ulang produk tersebmbunyi (Merubah status produk ke ‘103’ - ‘Aktif’)

Page 34: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

Method Type : PUT

Parameter : PathParam

Message Type : String(Number)

Returned Value : XML

API Key: REQUIRED

Request URL : http://api.elevenia.co.id/rest/prodstatservice/stat/restartdisplay/prdNo

Input Description

Nama Elemen Tipe

Data

Mandatory

Y/N

Panjang

Maks

Deskripsi

prdNo String Y ?

Parameter Product ID

provided in the

URL.

Contoh Input

1. HTTP Request:

http://api.elevenia.co.id/rest/prodstatservice/stat/restartdisplay/100

2. XML Data:

No XML Data

Output Description

Nama Elemen Tipe Data Deskripsi

message String Result message

resultCode String

Result code as follows:

200 = OK

500 = Business Error

-1000 = Server is under maintenance

Contoh Output

1. Berhasil:

Page 35: Spesifikasi API - elevenia : Your Online Shopping Paradisesoffice.elevenia.co.id/jsp/openapi/in/docs/ProductAPI... · 2015-12-17 · Profil pengiriman digunakan untuk menghitung biaya

2. Gagal: