Seekster Customer API (v1)

Download OpenAPI specification:Download

API Documentation for Seekster's API

Client Authentication

Client Authentication is achieved via HTTP Basic Authentication.

Credentials can be requested from Developer at [email protected].

Locales and Language

You can forcibly request a specific language by sending the locale parameter as a query parameter.

locale can currently be 1 of 2 values: [en, th]

Example:

GET /categories?locale=th

Otherwise, all endpoints with the X-Access-Token header set will use the current device's locale.

Finally, if no locale parameter has been set and no X-Access-Token header is present, the API will respond with the system's default locale.

Inquiries

Get all inquiries

query Parameters

active	boolean Active Scope
history	boolean History Scope
page	number Default: 1
per_page	number Default: 30

header Parameters

X-Access-Token

required

string

Access Token

Responses

Create new Inquiry

header Parameters

X-Access-Token

required

string

Access Token

Request Body schema: application/json

service_id required	string Service ID or Slug
additional_information	text
ref	string
route_id	string Route ID. Use instead of location_attributes when calling logistics-based packages
	object (Location)
	Array of objects (Order) Package and Quantity details
customer_id	String Customer Id
	Array of objects (Job) Dates
	Array of objects (Answer) Answers Details
	Array of objects (Attachment) Attachments
	object (Branch)
	object (Company)

Responses

Request samples

Payload

Content type

application/json

{"service_id": 1,
"additional_information": "Turn into Soi 3",
"ref": "seekstervip",
"route_id": 1,
"location_attributes": {"name": "Home or Work",
"contact_name": "John",
"phone_number": "0987654321",
"house_number": "1/1",
"project_name": "Mooban Sooksan",
"landmark": "Big C",
"alley": "Radio Alley",
"street": "Radio Road",
"province": "Bangkok",
"district": "Prawet",
"sub_district": "Dokmai",
"latitude": 13.014,
"longitude": 100.156,
"zip_code": "10110"
},
"orders_attributes": [{"package_id": 1,
"quantity": 1
}
],
"customer_id": 1,
"jobs_attributes": [{"start_time": "2018-12-31T15:00:00+07:00"
}
],
"answers_attributes": [{"question_id": 1,
"value": "10 Machines",
"choice_id": 2,
"choice_ids": [1,
2
],
"attachments_attributes": [{"file": "string",
"remote_file_url": "string",
"attachment_type": "string"
}
]
}
],
"attachments_attributes": [{"file": "string",
"remote_file_url": "string",
"attachment_type": "string"
}
],
"branch_attributes": {"name": "Big C Bang Ma"
},
"company_attributes": {"name": "Seekster",
"tax_number": "1231235123",
"phone_number": "0812345678",
"billing_email": "[email protected]",
"customer_ids": [1
],
"addresses_attributes": [{"name": "Home or Work",
"house_number": "1/1",
"project_name": "Mooban Sooksan",
"landmark": "Big C",
"alley": "Radio Alley",
"street": "Radio Road",
"province": "Bangkok",
"district": "Prawet",
"sub_district": "Dokmai",
"latitude": 13.014,
"longitude": 100.156,
"zip_code": "10110",
"contact_name": "John",
"phone_number": 987654321
}
],
"billing_address_attributes": {"name_en": "Seekster Co. Ltd",
"name_th": "บริษัท ซีคสเตอร์ จํากัด",
"house_number_en": "1/1",
"house_number_th": "1/1",
"project_name_en": "Mooban Sooksan",
"project_name_th": "หมู่บ้านสุขสันต์",
"floor_en": "8th Floor",
"floor_th": "ชั้น 8",
"landmark_en": "Big C",
"landmark_th": "บิ๊กซี",
"alley_en": "Radio Alley",
"alley_th": "ซอยวิทยุ",
"street_en": "Radio Road",
"street_th": "ถนนวิทยุ",
"province_en": "Bangkok",
"province_th": "กรุงเทพฯ",
"district_en": "Prawet",
"district_th": "ประเวศ",
"sub_district_en": "Dokmai",
"sub_district_th": "ดอกไม้",
"latitude": 13.014,
"longitude": 100.156,
"zip_code": "10110"
},
"contact_person_attributes": {"display_name": "Adam",
"first_name": "Adam",
"last_name": "Levine",
"email": "[email protected]",
"phone_number": "0812345678",
"date_of_birth": "1988-01-01",
"gender": "male",
"avatar": "string",
"remote_avatar_url": "http://fb.com/users/1/avatar.png"
}
}
}

Retrieve inquiry by id

path Parameters

id

required

string

ID

header Parameters

X-Access-Token

required

string

Access Token

Responses

Get jobs inside inquiry

path Parameters

id

required

string

ID

header Parameters

X-Access-Token

required

string

Access Token

Responses

Regions

Get all regions

query Parameters

locale

string

Enum: "en" "th"

Example: locale=th

Locale

Responses

Retrieve region by id

path Parameters

id

required

string

ID

query Parameters

locale

string

Enum: "en" "th"

Example: locale=th

Locale

Responses

Retrieve region by query params

query Parameters

locale	string Enum: "en" "th" Example: locale=th Locale
longitude required	string Latitude
latitude required	string Longitude
service_id	string Service ID

Responses

Services

Retrieve slot quantity

query Parameters

page	integer Example: page=1 Page number
locale	string Enum: "en" "th" Example: locale=th Locale
date	date Example: date=2023-02-09 Date selection

header Parameters

X-Access-Token

required

string

Access Token

Responses

Addresses

Get all addresses

query Parameters

locale	string Enum: "en" "th" Example: locale=th Locale
region_id	integer Region id

header Parameters

X-Access-Token

required

string

Access Token

Responses

Create new address

query Parameters

locale

string

Enum: "en" "th"

Example: locale=th

Locale

header Parameters

X-Access-Token

required

string

Access Token

Request Body schema: application/json

name	string Saved name for Users
house_number	string House/Room Number
project_name	string Apartment/Condo/Village Name
landmark	string Landmark
alley	string Alley/Road Name
street	string Street/Road Name
province	string
district	string
sub_district	string
latitude	float
longitude	float
zip_code	string
contact_name	string Name of point of contact
phone_number	string Phone number of point of contact

Responses

Request samples

Payload

Content type

application/json

{"name": "Home or Work",
"house_number": "1/1",
"project_name": "Mooban Sooksan",
"landmark": "Big C",
"alley": "Radio Alley",
"street": "Radio Road",
"province": "Bangkok",
"district": "Prawet",
"sub_district": "Dokmai",
"latitude": 13.014,
"longitude": 100.156,
"zip_code": "10110",
"contact_name": "John",
"phone_number": 987654321
}

Retrieve address by id

path Parameters

id

required

string

ID

query Parameters

locale

string

Enum: "en" "th"

Example: locale=th

Locale

header Parameters

X-Access-Token

required

string

Access Token

Responses

Update address

path Parameters

id

required

string

ID

query Parameters

locale

string

Enum: "en" "th"

Example: locale=th

Locale

header Parameters

X-Access-Token

required

string

Access Token

Request Body schema: application/json

name	string Saved name for Users
house_number	string House/Room Number
project_name	string Apartment/Condo/Village Name
landmark	string Landmark
alley	string Alley/Road Name
street	string Street/Road Name
province	string
district	string
sub_district	string
latitude	float
longitude	float
zip_code	string
contact_name	string Name of point of contact
phone_number	string Phone number of point of contact

Responses

Request samples

Payload

Content type

application/json

{"name": "Home or Work",
"house_number": "1/1",
"project_name": "Mooban Sooksan",
"landmark": "Big C",
"alley": "Radio Alley",
"street": "Radio Road",
"province": "Bangkok",
"district": "Prawet",
"sub_district": "Dokmai",
"latitude": 13.014,
"longitude": 100.156,
"zip_code": "10110",
"contact_name": "John",
"phone_number": 987654321
}

Remove address

path Parameters

id

required

string

ID

query Parameters

locale

string

Enum: "en" "th"

Example: locale=th

Locale

header Parameters

X-Access-Token

required

string

Access Token

Responses

Cards

Get all cards

header Parameters

X-Access-Token

required

string

Access Token

Responses

Create new card

header Parameters

X-Access-Token

required

string

Access Token

Request Body schema: application/json

token

string

Use Omise SDK to create tokens.

Responses

Request samples

Payload

Content type

application/json

{"token": "tokn_test_57pq64nfadnz4mvr2q2"
}

Retrieve card by id

path Parameters

id

required

string

ID

header Parameters

X-Access-Token

required

string

Access Token

Responses

Remove card

path Parameters

id

required

string

ID

header Parameters

X-Access-Token

required

string

Access Token

Responses

Invoices

Pay by card

path Parameters

invoice_id

required

string

Invoice ID

header Parameters

X-Access-Token

required

string

Access Token

Request Body schema: application/json

amount_satangs	integer Payment Amount (in Satangs)
amount_currency	string Payment Currency
	object (Charge)

Responses

Request samples

Payload

Content type

application/json

{"amount_satangs": 49900,
"amount_currency": "thb",
"charge_attributes": {"token": "tokn_12312478hc18dd",
"card_id": 1
}
}

Pay by cash

path Parameters

invoice_id

required

string

Invoice ID

header Parameters

X-Access-Token

required

string

Access Token

Request Body schema: application/json

amount_satangs	integer Payment Amount (in Satangs)
amount_currency	string Payment Currency

Responses

Request samples

Payload

Content type

application/json

{"amount_satangs": 49900,
"amount_currency": "thb"
}

Pay by transfer

path Parameters

invoice_id

required

string

Invoice ID

header Parameters

X-Access-Token

required

string

Access Token

Request Body schema: application/json

amount_satangs	integer Payment Amount (in Satangs)
amount_currency	string Payment Currency
captured_at	string Captured at
bank_account_id	string Bank Account
	object (BankTransfer)

Responses

Request samples

Payload

Content type

application/json

{"amount_satangs": 49900,
"amount_currency": "thb",
"captured_at": "2021-07-23T10:56:04.808+07:00",
"bank_account_id": 1,
"bank_transfer_attributes": {"image": "string"
}
}

Pay by Seekster wallet

path Parameters

invoice_id

required

string

Invoice ID

header Parameters

X-Access-Token

required

string

Access Token

Request Body schema: application/json

amount_satangs	integer Payment Amount (in Satangs)
amount_currency	string Payment Currency

Responses

Request samples

Payload

Content type

application/json

{"amount_satangs": 49900,
"amount_currency": "thb"
}