Site Information

>>>

POST /api/v1/site_information
Create Site Information

Creates a new site information record for the onboarding live application of the currently authenticated merchant.

betaThis API is a pre-release. Please contact KOMOJU to obtain more usage instructions before using it.

Examples

  • cURL
  • Node.js
  • Ruby
curl -X POST https://komoju.com/api/v1/live_application/site_information \
  -u sk_123456: \
  -d "site_name=Gaylord%20and%20Sons" \
  -d "site_name_kana=%EF%BD%B6%EF%BE%80%EF%BD%B6%EF%BE%85" \
  -d "site_name_alphabet=C.R.E.A.M" \
  -d "site_url=http%3A%2F%2Fward.co%2Fnigel" \
  -d "site_integration_type=shopify" \
  -d "establishment_date=2020-11-19" \
  -d "store_country=JP" \
  -d "store_postal_code=28461-1338" \
  -d "store_prefecture_state=Louisiana" \
  -d "store_prefecture_state_kana=" \
  -d "store_city=South%20Anneside" \
  -d "store_city_kana=" \
  -d "store_address=57566%20Hai%20Turnpike" \
  -d "store_address_kana=%EF%BD%B6%EF%BE%80%EF%BD%B6%EF%BE%85" \
  -d "store_building_name=Park%20Crossing" \
  -d "store_building_name_kana=%EF%BD%B6%EF%BE%80%EF%BD%B6%EF%BE%85" \
  -d "site_product_description=Lightweight%20Cotton%20Lamp" \
  -d "site_annual_sales=6420493533" \
  -d "site_annual_sales_currency=JPY" \
  -d "site_average_transactional_value=300" \
  -d "site_average_transactional_currency=JPY" \
  -d "site_minimum_product_pricing_cents=1" \
  -d "site_minimum_product_pricing_currency=JPY" \
  -d "site_maximum_product_pricing_cents=1000" \
  -d "site_maximum_product_pricing_currency=JPY" \
  -d "sctl_url=http%3A%2F%2Fkuhn.co%2Ftrea" \
  -d "aup_accepted=true" 
var querystring = require('querystring');
var https = require('https');
var secret_key = 'sk_123456'
var auth = 'Basic ' + Buffer.from(secret_key + ':').toString('base64');
var post_data = querystring.stringify({
  'site_name': 'Gaylord and Sons',
  'site_name_kana': 'ｶﾀｶﾅ',
  'site_name_alphabet': 'C.R.E.A.M',
  'site_url': 'http://ward.co/nigel',
  'site_integration_type': 'shopify',
  'establishment_date': '2020-11-19',
  'store_country': 'JP',
  'store_postal_code': '28461-1338',
  'store_prefecture_state': 'Louisiana',
  'store_prefecture_state_kana': '',
  'store_city': 'South Anneside',
  'store_city_kana': '',
  'store_address': '57566 Hai Turnpike',
  'store_address_kana': 'ｶﾀｶﾅ',
  'store_building_name': 'Park Crossing',
  'store_building_name_kana': 'ｶﾀｶﾅ',
  'site_product_description': 'Lightweight Cotton Lamp',
  'site_annual_sales': '6420493533',
  'site_annual_sales_currency': 'JPY',
  'site_average_transactional_value': '300',
  'site_average_transactional_currency': 'JPY',
  'site_minimum_product_pricing_cents': '1',
  'site_minimum_product_pricing_currency': 'JPY',
  'site_maximum_product_pricing_cents': '1000',
  'site_maximum_product_pricing_currency': 'JPY',
  'sctl_url': 'http://kuhn.co/trea',
  'aup_accepted': 'true'
});

var post_options = {
  host: 'komoju.com',
  port: '443',
  path: '/api/v1/live_application/site_information',
  method: 'POST',
  headers: {
    'Authorization': auth,
    'Content-Length': Buffer.byteLength(post_data)
  }
};

var post_req = https.request(post_options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function (chunk) {
        console.log(chunk);
    });
});

post_req.write(post_data);
post_req.end();
require 'uri'
require 'net/https'
require 'json'
require 'base64'
require 'pp'
uri = URI.parse('https://komoju.com/api/v1/live_application/site_information')
https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true
secret_key = 'sk_123456'
auth = Base64.encode64("#{secret_key}:")
headers = {
  'Content-Type' => 'application/json',
  'Authorization' => "Basic #{auth}"
}

body = {
  site_name: "Gaylord and Sons",
  site_name_kana: "ｶﾀｶﾅ",
  site_name_alphabet: "C.R.E.A.M",
  site_url: "http://ward.co/nigel",
  site_integration_type: "shopify",
  establishment_date: "2020-11-19",
  store_country: "JP",
  store_postal_code: "28461-1338",
  store_prefecture_state: "Louisiana",
  store_prefecture_state_kana: "",
  store_city: "South Anneside",
  store_city_kana: "",
  store_address: "57566 Hai Turnpike",
  store_address_kana: "ｶﾀｶﾅ",
  store_building_name: "Park Crossing",
  store_building_name_kana: "ｶﾀｶﾅ",
  site_product_description: "Lightweight Cotton Lamp",
  site_annual_sales: "6420493533",
  site_annual_sales_currency: "JPY",
  site_average_transactional_value: "300",
  site_average_transactional_currency: "JPY",
  site_minimum_product_pricing_cents: "1",
  site_minimum_product_pricing_currency: "JPY",
  site_maximum_product_pricing_cents: "1000",
  site_maximum_product_pricing_currency: "JPY",
  sctl_url: "http://kuhn.co/trea",
  aup_accepted: "true"
}

res = https.post(
  uri.path,
  body.to_json,
  headers
)

puts res.body
{
  "resource": "site_information",
  "status": "pending",
  "created_at": "2021-03-05T13:06:27.000+09:00",
  "updated_at": "2021-03-05T13:06:27.000+09:00",
  "site_name": "Gaylord and Sons",
  "site_name_kana": "ｶﾀｶﾅ",
  "site_name_alphabet": "C.R.E.A.M",
  "site_url": "http://ward.co/nigel",
  "site_integration_type": "shopify",
  "establishment_date": "2020-11-19",
  "store_country": "JP",
  "store_postal_code": "28461-1338",
  "store_prefecture_state": "Louisiana",
  "store_prefecture_state_kana": null,
  "store_city": "South Anneside",
  "store_city_kana": null,
  "store_address": "57566 Hai Turnpike",
  "store_address_kana": "ｶﾀｶﾅ",
  "store_building_name": "Park Crossing",
  "store_building_name_kana": "ｶﾀｶﾅ",
  "site_product_description": "Lightweight Cotton Lamp",
  "site_annual_sales": 6420493533,
  "site_annual_sales_currency": "JPY",
  "site_average_transactional_value": 300,
  "site_average_transactional_currency": "JPY",
  "site_minimum_product_pricing_cents": 1,
  "site_minimum_product_pricing_currency": "JPY",
  "site_maximum_product_pricing_cents": 1000,
  "site_maximum_product_pricing_currency": "JPY",
  "sctl_url": "http://kuhn.co/trea",
  "sales_permit_required": false,
  "aup_accepted": true
}

Params

Param name Description
site_name
optional

Site Name of the Site Information.
site_name_kana
optional

Site Name (Kana) of the Site Information.
site_name_alphabet
optional

Site Name (Alphabet) of the Site Information.
site_url
optional

Site URL of the Site Information.
site_integration_type
optional

Integration Type of the Site Information..

It must be one of the following values
  • multipay
  • shopify
  • wix
  • hosted_page
  • api
  • woocommerce
  • magento
  • other
establishment_date
optional

Site Establishment Date of the Site Information..

store_country
optional

Country of the Store Address.

Must be one of the following values (i.e. represented in ISO 3166-1 alpha-2)
  • TJ
  • ST
  • MS
  • AE
  • NL
  • LU
  • BZ
  • BO
  • UY
  • SA
  • CI
  • MF
  • TF
  • AI
  • QA
  • SX
  • BV
  • PG
  • KG
  • GQ
  • EH
  • NU
  • PR
  • GD
  • KR
  • HM
  • SM
  • SL
  • CD
  • MK
  • TR
  • DZ
  • GE
  • PS
  • GP
  • PF
  • NA
  • TG
  • DO
  • AQ
  • CH
  • MG
  • FO
  • VG
  • GI
  • BN
  • LA
  • IS
  • EE
  • UM
  • LT
  • MR
  • AD
  • HU
  • TK
  • MY
  • AO
  • CV
  • NF
  • BE
  • PT
  • GB
  • IM
  • US
  • HK
  • AZ
  • CC
  • ML
  • SK
  • VU
  • TL
  • HR
  • SR
  • CZ
  • PM
  • LS
  • WS
  • KM
  • IT
  • BI
  • WF
  • GN
  • SG
  • CO
  • CN
  • AW
  • MA
  • FI
  • VA
  • KY
  • BH
  • PY
  • EC
  • LR
  • PL
  • OM
  • MT
  • SS
  • DE
  • TM
  • SJ
  • TT
  • IL
  • BD
  • NR
  • LK
  • NG
  • BQ
  • MX
  • CW
  • SI
  • MN
  • CA
  • AX
  • VN
  • TW
  • JP
  • IO
  • RO
  • BG
  • GU
  • BR
  • AM
  • ZM
  • DJ
  • JE
  • AT
  • CM
  • SE
  • FJ
  • KZ
  • GL
  • GY
  • CX
  • MW
  • ZA
  • TO
  • CY
  • MV
  • PN
  • RW
  • KN
  • BJ
  • ET
  • GM
  • TZ
  • VC
  • FK
  • MC
  • AU
  • CL
  • DK
  • FR
  • TC
  • MZ
  • NE
  • GT
  • LI
  • NP
  • BF
  • PW
  • KW
  • IN
  • GA
  • TV
  • MO
  • SH
  • MD
  • CK
  • AR
  • SC
  • IE
  • ES
  • LB
  • BM
  • RE
  • KI
  • AG
  • MQ
  • SV
  • JO
  • TH
  • MH
  • CG
  • GF
  • BA
  • YT
  • GS
  • KE
  • PE
  • BT
  • SZ
  • CR
  • TD
  • DM
  • NC
  • GR
  • GG
  • HN
  • VI
  • CF
  • SN
  • AF
  • MP
  • PH
  • BY
  • LV
  • NO
  • EG
  • IQ
  • LC
  • NZ
  • BL
  • UZ
  • ID
  • ER
  • FM
  • SB
  • ME
  • AS
store_postal_code
optional

Address of the Store Address.

store_prefecture_state
optional

Prefecture/State of the Store Address.

store_prefecture_state_kana
optional

Prefecture/State (Kana) of the Store Address.

store_city
optional

City of the Store Address.

store_city_kana
optional

City (Kana) of the Store Address.

store_address
optional

Address of the Store Address.

store_address_kana
optional

Address (Kana) of the Store Address.

store_building_name
optional

Building Name of the Store Address.

store_building_name_kana
optional

Building Name (Kana) of the Store Address.

site_product_description
optional

Product Description of the Site Information.
site_annual_sales
optional

Annual Sales Forecast Cents of the Site Information.
site_annual_sales_currency
optional

Annual Sales Forecast Currency of the Site Information.
site_average_transactional_value
optional

Average Transactional Value Cents of the Site Information.
site_average_transactional_currency
optional

Average Transactional Value Currency of the Site Information.
site_minimum_product_pricing_cents
optional

Minimum Product Pricing Cents of the Site Information.
site_minimum_product_pricing_currency
optional

Minimum Product Pricing Currency of the Site Information.
site_maximum_product_pricing_cents
optional

Minimum Product Pricing Cents of the Site Information.
site_maximum_product_pricing_currency
optional

Maximum Product Pricing Currency of the Site Information.
sctl_url
optional

Notation based on Specified Commercial Transactions Law URL. A Specified Commercial Transaction Act page is required when operating an online shop in Japan. During the examination process, we check if the page exists and confirm the contents of the page. For more details, please see What is the Specified Commercial Transactions Law? or Article of Specified Commercial Transaction Law (PDF:166KB).
aup_accepted
optional

Have the merchant acknowledged and read the acceptable use policy and agree with the acceptable use policy?
>>>

GET /api/v1/site_information
Show Site Information

Show the fields of an existing site information record for the onboarding live application of the currently authenticated merchant.

betaThis API is a pre-release. Please contact KOMOJU to obtain more usage instructions before using it.

Examples

  • cURL
  • Node.js
  • Ruby
curl -X GET https://komoju.com/api/v1/live_application/site_information \
  -u sk_123456:
var https = require('https');
var secret_key = 'sk_123456'
var auth = 'Basic ' + Buffer.from(secret_key + ':').toString('base64');
var get_options = {
  host: 'komoju.com',
  port: '443',
  path: '/api/v1/live_application/site_information',
  method: 'GET',
  headers: {
    'Authorization': auth
  }
};

var get_req = https.request(get_options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function (chunk) {
        console.log(chunk);
    });
});

get_req.end();
require 'uri'
require 'net/https'
require 'json'
require 'base64'
require 'pp'
uri = URI.parse('https://komoju.com/api/v1/live_application/site_information')
https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true
secret_key = 'sk_123456'
auth = Base64.encode64("#{secret_key}:")
headers = {
  'Content-Type' => 'application/json',
  'Authorization' => "Basic #{auth}"
}

res = https.get(uri.path, headers)
puts res.body
{
  "resource": "site_information",
  "status": "pending",
  "created_at": "2021-03-05T13:06:27.000+09:00",
  "updated_at": "2021-03-05T13:06:27.000+09:00",
  "site_name": "Gaylord and Sons",
  "site_name_kana": "ｶﾀｶﾅ",
  "site_name_alphabet": "C.R.E.A.M",
  "site_url": "http://ward.co/nigel",
  "site_integration_type": "shopify",
  "establishment_date": "2020-11-19",
  "store_country": "JP",
  "store_postal_code": "28461-1338",
  "store_prefecture_state": "Louisiana",
  "store_prefecture_state_kana": null,
  "store_city": "South Anneside",
  "store_city_kana": null,
  "store_address": "57566 Hai Turnpike",
  "store_address_kana": "ｶﾀｶﾅ",
  "store_building_name": "Park Crossing",
  "store_building_name_kana": "ｶﾀｶﾅ",
  "site_product_description": "Lightweight Cotton Lamp",
  "site_annual_sales": 6420493533,
  "site_annual_sales_currency": "JPY",
  "site_average_transactional_value": 300,
  "site_average_transactional_currency": "JPY",
  "site_minimum_product_pricing_cents": 1,
  "site_minimum_product_pricing_currency": "JPY",
  "site_maximum_product_pricing_cents": 1000,
  "site_maximum_product_pricing_currency": "JPY",
  "sctl_url": "http://kuhn.co/trea",
  "sales_permit_required": false,
  "aup_accepted": true
}
>>>

PATCH /api/v1/site_information
Update Site Information

Update the fields of an existing site information record for the onboarding live application of the currently authenticated merchant.

betaThis API is a pre-release. Please contact KOMOJU to obtain more usage instructions before using it.

Examples

  • cURL
  • Node.js
  • Ruby
curl -X PATCH https://komoju.com/api/v1/live_application/site_information \
  -u sk_123456: \
  -d "site_name=I%20am%20changing%20this%20in%20this%20request" 
var querystring = require('querystring');
var https = require('https');
var secret_key = 'sk_123456'
var auth = 'Basic ' + Buffer.from(secret_key + ':').toString('base64');
var patch_data = querystring.stringify({
  'site_name': 'I am changing this in this request'
});

var patch_options = {
  host: 'komoju.com',
  port: '443',
  path: '/api/v1/live_application/site_information',
  method: 'PATCH',
  headers: {
    'Authorization': auth,
    'Content-Length': Buffer.byteLength(patch_data)
  }
};

var patch_req = https.request(patch_options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function (chunk) {
        console.log(chunk);
    });
});

patch_req.write(patch_data);
patch_req.end();
require 'uri'
require 'net/https'
require 'json'
require 'base64'
require 'pp'
uri = URI.parse('https://komoju.com/api/v1/live_application/site_information')
https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true
secret_key = 'sk_123456'
auth = Base64.encode64("#{secret_key}:")
headers = {
  'Content-Type' => 'application/json',
  'Authorization' => "Basic #{auth}"
}

body = {
  site_name: "I am changing this in this request"
}

res = https.patch(
  uri.path,
  body.to_json,
  headers
)

puts res.body
{
  "resource": "site_information",
  "status": "pending",
  "created_at": "2021-03-05T13:06:27.000+09:00",
  "updated_at": "2021-03-05T13:06:27.000+09:00",
  "site_name": "I am changing this in this request",
  "site_name_kana": "ｶﾀｶﾅ",
  "site_name_alphabet": "C.R.E.A.M",
  "site_url": "http://ward.co/nigel",
  "site_integration_type": "shopify",
  "establishment_date": "2020-11-19",
  "store_country": "JP",
  "store_postal_code": "28461-1338",
  "store_prefecture_state": "Louisiana",
  "store_prefecture_state_kana": null,
  "store_city": "South Anneside",
  "store_city_kana": null,
  "store_address": "57566 Hai Turnpike",
  "store_address_kana": "ｶﾀｶﾅ",
  "store_building_name": "Park Crossing",
  "store_building_name_kana": "ｶﾀｶﾅ",
  "site_product_description": "Lightweight Cotton Lamp",
  "site_annual_sales": 6420493533,
  "site_annual_sales_currency": "JPY",
  "site_average_transactional_value": 300,
  "site_average_transactional_currency": "JPY",
  "site_minimum_product_pricing_cents": 1,
  "site_minimum_product_pricing_currency": "JPY",
  "site_maximum_product_pricing_cents": 1000,
  "site_maximum_product_pricing_currency": "JPY",
  "sctl_url": "http://kuhn.co/trea",
  "sales_permit_required": false,
  "aup_accepted": true
}

Params

Param name Description
site_name
optional

Site Name of the Site Information.
site_name_kana
optional

Site Name (Kana) of the Site Information.
site_name_alphabet
optional

Site Name (Alphabet) of the Site Information.
site_url
optional

Site URL of the Site Information.
site_integration_type
optional

Integration Type of the Site Information..

It must be one of the following values
  • multipay
  • shopify
  • wix
  • hosted_page
  • api
  • woocommerce
  • magento
  • other
establishment_date
optional

Site Establishment Date of the Site Information..

store_country
optional

Country of the Store Address.

Must be one of the following values (i.e. represented in ISO 3166-1 alpha-2)
  • TJ
  • ST
  • MS
  • AE
  • NL
  • LU
  • BZ
  • BO
  • UY
  • SA
  • CI
  • MF
  • TF
  • AI
  • QA
  • SX
  • BV
  • PG
  • KG
  • GQ
  • EH
  • NU
  • PR
  • GD
  • KR
  • HM
  • SM
  • SL
  • CD
  • MK
  • TR
  • DZ
  • GE
  • PS
  • GP
  • PF
  • NA
  • TG
  • DO
  • AQ
  • CH
  • MG
  • FO
  • VG
  • GI
  • BN
  • LA
  • IS
  • EE
  • UM
  • LT
  • MR
  • AD
  • HU
  • TK
  • MY
  • AO
  • CV
  • NF
  • BE
  • PT
  • GB
  • IM
  • US
  • HK
  • AZ
  • CC
  • ML
  • SK
  • VU
  • TL
  • HR
  • SR
  • CZ
  • PM
  • LS
  • WS
  • KM
  • IT
  • BI
  • WF
  • GN
  • SG
  • CO
  • CN
  • AW
  • MA
  • FI
  • VA
  • KY
  • BH
  • PY
  • EC
  • LR
  • PL
  • OM
  • MT
  • SS
  • DE
  • TM
  • SJ
  • TT
  • IL
  • BD
  • NR
  • LK
  • NG
  • BQ
  • MX
  • CW
  • SI
  • MN
  • CA
  • AX
  • VN
  • TW
  • JP
  • IO
  • RO
  • BG
  • GU
  • BR
  • AM
  • ZM
  • DJ
  • JE
  • AT
  • CM
  • SE
  • FJ
  • KZ
  • GL
  • GY
  • CX
  • MW
  • ZA
  • TO
  • CY
  • MV
  • PN
  • RW
  • KN
  • BJ
  • ET
  • GM
  • TZ
  • VC
  • FK
  • MC
  • AU
  • CL
  • DK
  • FR
  • TC
  • MZ
  • NE
  • GT
  • LI
  • NP
  • BF
  • PW
  • KW
  • IN
  • GA
  • TV
  • MO
  • SH
  • MD
  • CK
  • AR
  • SC
  • IE
  • ES
  • LB
  • BM
  • RE
  • KI
  • AG
  • MQ
  • SV
  • JO
  • TH
  • MH
  • CG
  • GF
  • BA
  • YT
  • GS
  • KE
  • PE
  • BT
  • SZ
  • CR
  • TD
  • DM
  • NC
  • GR
  • GG
  • HN
  • VI
  • CF
  • SN
  • AF
  • MP
  • PH
  • BY
  • LV
  • NO
  • EG
  • IQ
  • LC
  • NZ
  • BL
  • UZ
  • ID
  • ER
  • FM
  • SB
  • ME
  • AS
store_postal_code
optional

Address of the Store Address.

store_prefecture_state
optional

Prefecture/State of the Store Address.

store_prefecture_state_kana
optional

Prefecture/State (Kana) of the Store Address.

store_city
optional

City of the Store Address.

store_city_kana
optional

City (Kana) of the Store Address.

store_address
optional

Address of the Store Address.

store_address_kana
optional

Address (Kana) of the Store Address.

store_building_name
optional

Building Name of the Store Address.

store_building_name_kana
optional

Building Name (Kana) of the Store Address.

site_product_description
optional

Product Description of the Site Information.
site_annual_sales
optional

Annual Sales Forecast Cents of the Site Information.
site_annual_sales_currency
optional

Annual Sales Forecast Currency of the Site Information.
site_average_transactional_value
optional

Average Transactional Value Cents of the Site Information.
site_average_transactional_currency
optional

Average Transactional Value Currency of the Site Information.
site_minimum_product_pricing_cents
optional

Minimum Product Pricing Cents of the Site Information.
site_minimum_product_pricing_currency
optional

Minimum Product Pricing Currency of the Site Information.
site_maximum_product_pricing_cents
optional

Minimum Product Pricing Cents of the Site Information.
site_maximum_product_pricing_currency
optional

Maximum Product Pricing Currency of the Site Information.
sctl_url
optional

Notation based on Specified Commercial Transactions Law URL. A Specified Commercial Transaction Act page is required when operating an online shop in Japan. During the examination process, we check if the page exists and confirm the contents of the page. For more details, please see What is the Specified Commercial Transactions Law? or Article of Specified Commercial Transaction Law (PDF:166KB).
aup_accepted
optional

Have the merchant acknowledged and read the acceptable use policy and agree with the acceptable use policy?