Page365 API API Reference

Successful operation

PublicApp

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createPublicApp": {
      "email": "string",
      "id": "string",
      "name": "string",
      "phone": "string",
      "status": "string",
      "webhookUrl": "string"
    }
  }
}

Authentication

After profile approved, Page365 will send you SECRET_KEY which will be use as part of access token creating process. Access token is needed for every request as an identifier and each merchant will use difference unique access token even from the same profile.

In access token creation process you will need 2 parameters (SECRET_KEY, MERCHANT_TOKEN) you can find MERCHANT_TOKEN from each merchant directly and

PROVIDER NEEDS TO KEEP MERCHANT_TOKEN IN PRIVATE AND NOT ALLOW TO PUBLIC TOKEN TO OTHER

Authentication

Generate access token

Generate access token for using in identification when calling API

secretKey:

string

Secret key which you receive after your profile approved

merchantToken:

string

Unique token for each merchant generate by Page365

Example

Request Content-Types: application/json

Query

query generateToken($secretKey: String!, $merchantToken: String!){
  generateToken(secretKey: $secretKey, merchantToken: $merchantToken)
}

Variables

{
  "secretKey": "string",
  "merchantToken": "string"
}

Try it now

Successful operation

Page365 will send to webhook url an order object when the order has updated or created.

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "generateToken": "string"
  }
}

Webhooks

After the profile is approved and allowed by the merchant account, Page365 will send an event that has occurred on the merchant account.

Validating Payloads: - Every webhook will have SHA1 signature included in the request's X-Hub-Signature header, preceded with sha1=. You don't have to validate the payload, but you should.

To validate the payload: - Generate a SHA1 signature using the payload and your secret_key - Compare your signature to the signature in the X-Hub-Signature header (everything after sha1=). If the signatures match, the payload is genuine.

HTTP method: - Use POST http method for send to webhook url.

#Order event

event type should be "order.create" for create event and "order.update" for update event

a token reference with the merchant account.

an order object.

Unique object reference number.

stage:

Can be (draft, unpaid, transferred, paid, shipped).

createdAt:

ISO8601DateTime

Timestamp when order create.

Note.

Delivery cost in baht.

Discount.

Sum of items price.

Final price which send to customer.

No.

Expire date.

Total amount paid by customer.

paidAt:

ISO8601DateTime

Timestamp when customer paid.

Slug.

Delivery tracking code.

itemsCount:

Int

Number of item in this order.

Shipping title.

True if customer already receive order inform.

sold:

Boolean

Customer already paid (stage paid, shipped).

promotionCode:

Page365 will send to webhook url a order item object when the customer has updated or created.

Promotion code which be use in this order.

Vat amount.

Vat include.

Tax no.

customer name.

customer address.

customer email.

customer phone.

Create by CF feature.

Detail link.

Items in order.

Bank account for this order payment.

Payment slip.

Unique object reference number.

Name.

Note.

Quantity.

Price.

Sum of items price.

Unique object reference number of product.

BankAccount object

id:

Unique object reference number.

Bank account number.

Name.

Provider code.

Verify code.

Create at.

Update at.

event type should be "orderitem.create" for create event and "orderitem.update" for update event

Page365 will send to webhook url a bank account object when the bank account has updated or created.

a token reference with the merchant account.

body:

Order item object

an order item object.

OrderItem object

id:

Unique object reference number.

Name.

Note.

Quantity.

Price.

Sum of items price.

Unique object reference number of product.

orderId:

Unique object reference number of order.

Body example

#Bank account event

event type should be "bankaccount.create" for create event and "bankaccount.update" for update event

Page365 will send to webhook url a customer object when the customer has updated or created.

a token reference with the merchant account.

body:

Bank account object

an bank account object.

BankAccount object

id:

Unique object reference number.

Bank account number.

Name.

Provider code.

event type should be "customer.create" for create event and "customer.update" for update event

a token reference with the merchant account.

a customer object.

Unique object reference number.

Name.

Phone.

Email.

Address.

Note.

Plateform which customer come from.

Customer tags.

Unique object reference number.

name:

Name.

Body example

Product

Fetch merchant product information

Product

Fetch products

Fetch all product information owned by merchant

first:

integer

Returns the first n elements from the list.

after:

string

Returns the elements in the list that come after the specified cursor.

last:

integer

Returns the last n elements from the list.

before:

string

Returns the elements in the list that come before the specified cursor.

token:

string

Access token from authentication operation

search:

string

Filter by matching argument with name, detail, variant name or variant code

status:

string

Filter by status

scope:

string

Filter by stock type (stockable, unstockable, all)

categoryId:

string

Filter by category

orderBy:

string

Sort by field (sold, actual, reserved, bestsellers) and type (desc, asc) eg. "sold_desc"

enabled:

boolean

Filter by field enabled

Example

Request Content-Types: application/json

Query

query products($first: Int, $after: String, $last: Int, $before: String, $token: String!, $search: String, $status: String, $scope: String, $categoryId: String, $orderBy: String, $enabled: Boolean){
  products(first: $first, after: $after, last: $last, before: $before, token: $token, search: $search, status: $status, scope: $scope, categoryId: $categoryId, orderBy: $orderBy, enabled: $enabled){
  }
}

Variables

{
  "first": "integer",
  "after": "string",
  "last": "integer",
  "before": "string",
  "token": "string",
  "search": "string",
  "status": "string",
  "scope": "string",
  "categoryId": "string",
  "orderBy": "string",
  "enabled": "boolean"
}

Try it now

Successful operation

ProductConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "products": {}
  }
}

Product

Fetch product

Fetch product information by id

id:

integer

Unique object reference number

token:

string

Access token from authentication operation

Example

Request Content-Types: application/json

Query

query product($id: Int!, $token: String!){
  product(id: $id, token: $token){
    actual
    available
    cost
    detail
    enabled
    id
    name
    ordersCount
    price
    priceBeforeDiscount
    refUrl
    reserved
    sold
    statuses
    stockable
    thumbnail
    updatedAt
    url
    variable
    weight
    whenOutOfStock
  }
}

Variables

{
  "id": "integer",
  "token": "string"
}

Try it now

Successful operation

Product

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "product": {
      "actual": "integer",
      "available": "integer",
      "cost": "number",
      "detail": "string",
      "enabled": "boolean",
      "id": "string",
      "name": "string",
      "ordersCount": "integer",
      "price": "number",
      "priceBeforeDiscount": "number",
      "refUrl": "string",
      "reserved": "integer",
      "sold": "integer",
      "statuses": [
        "string"
      ],
      "stockable": "boolean",
      "thumbnail": "string",
      "url": "string",
      "variable": "boolean",
      "weight": "number",
      "whenOutOfStock": "string"
    }
  }
}

Product Category

Fetch merchant product category information

Product Category

Fetch product categories

Fetch all product category information owned by merchant

first:

integer

Returns the first n elements from the list.

after:

string

Returns the elements in the list that come after the specified cursor.

last:

integer

Returns the last n elements from the list.

before:

string

Returns the elements in the list that come before the specified cursor.

token:

string

Access token from authentication operation

sort:

string

Sort result ascending by specific field

Example

Request Content-Types: application/json

Query

query productCategories($first: Int, $after: String, $last: Int, $before: String, $token: String!, $sort: String){
  productCategories(first: $first, after: $after, last: $last, before: $before, token: $token, sort: $sort){
  }
}

Variables

{
  "first": "integer",
  "after": "string",
  "last": "integer",
  "before": "string",
  "token": "string",
  "sort": "string"
}

Try it now

Successful operation

ProductCategoryConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productCategories": {}
  }
}

Product Category

Fetch product category

Fetch product category information by id

id:

integer

Unique object reference number

token:

string

Access token from authentication operation

Example

Request Content-Types: application/json

Query

query productCategory($id: Int!, $token: String!){
  productCategory(id: $id, token: $token){
    albumName
    autoImport
    description
    editable
    enabled
    id
    name
    size
    thumbnail
  }
}

Variables

{
  "id": "integer",
  "token": "string"
}

Try it now

Successful operation

ProductCategory

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productCategory": {
      "albumName": "string",
      "autoImport": "boolean",
      "description": "string",
      "editable": "boolean",
      "enabled": "boolean",
      "id": "string",
      "name": "string",
      "size": "integer",
      "thumbnail": "string"
    }
  }
}

Order

Fetch merchant order information

Order

Fetch orders

Fetch all order information owned by merchant

first:

integer

Returns the first n elements from the list.

after:

string

Returns the elements in the list that come after the specified cursor.

last:

integer

Returns the last n elements from the list.

before:

string

Returns the elements in the list that come before the specified cursor.

token:

string

Access token from authentication operation

sort:

string

Sort result ascending by specific field

stage:

string

Filter by stage (draft, unpaid, transferred, paid, shipped)

bankAccountId:

integer

Filter by bank

userId:

integer

Filter by user

sinceCreatedAt:

string

Filter by create date format YYYY-MM-DD (since)

untilCreatedAt:

string

Filter by create date format YYYY-MM-DD (until)

Example

Request Content-Types: application/json

Query

query orders($first: Int, $after: String, $last: Int, $before: String, $token: String!, $sort: String, $stage: String, $bankAccountId: Int, $userId: Int, $sinceCreatedAt: String, $untilCreatedAt: String){
  orders(first: $first, after: $after, last: $last, before: $before, token: $token, sort: $sort, stage: $stage, bankAccountId: $bankAccountId, userId: $userId, sinceCreatedAt: $sinceCreatedAt, untilCreatedAt: $untilCreatedAt){
  }
}

Variables

{
  "first": "integer",
  "after": "string",
  "last": "integer",
  "before": "string",
  "token": "string",
  "sort": "string",
  "stage": "string",
  "bankAccountId": "integer",
  "userId": "integer",
  "sinceCreatedAt": "string",
  "untilCreatedAt": "string"
}

Try it now

Successful operation

OrderConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "orders": {}
  }
}

Order

Fetch order

Fetch order information by id

id:

integer

Unique object reference number

token:

string

Access token from authentication operation

Example

Request Content-Types: application/json

Query

query order($id: Int!, $token: String!){
  order(id: $id, token: $token){
    auto
    createdAt
    discount
    expiresOn
    id
    itemsCount
    no
    note
    paidAmount
    paidAt
    promotionCode
    sent
    shippingCost
    shippingOption
    slug
    sold
    stage
    subtotal
    taxInvoiceNo
    total
    trackingCode
    url
    vat
    vatIncluded
  }
}

Variables

{
  "id": "integer",
  "token": "string"
}

Try it now

Successful operation

Order

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "order": {
      "auto": "boolean",
      "discount": "number",
      "id": "string",
      "itemsCount": "integer",
      "no": "integer",
      "note": "string",
      "paidAmount": "number",
      "promotionCode": "string",
      "sent": "boolean",
      "shippingCost": "number",
      "shippingOption": "string",
      "slug": "string",
      "sold": "boolean",
      "stage": "string",
      "subtotal": "number",
      "taxInvoiceNo": "string",
      "total": "number",
      "trackingCode": "string",
      "url": "string",
      "vat": "number",
      "vatIncluded": "boolean"
    }
  }
}

Stock

Update stock

Stock

Update stock

Update product stock owned by merchant

token:

string

Access token from authentication operation

sku:

string

SKU

price:

number

Price

quantity:

integer

Quantity

note:

string

Note

Example

Request Content-Types: application/json

Query

mutation createStockMove($token: String!, $sku: String!, $price: Float!, $quantity: Int!, $note: String){
  createStockMove(token: $token, sku: $sku, price: $price, quantity: $quantity, note: $note){
    createdAt
    id
    note
    price
    quantity
    quantityAbs
    type
  }
}

Variables

{
  "token": "string",
  "sku": "string",
  "price": "number",
  "quantity": "integer",
  "note": "string"
}

Try it now

Successful operation

StockMove

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createStockMove": {
      "id": "string",
      "note": "string",
      "price": "number",
      "quantity": "integer",
      "quantityAbs": "integer",
      "type": "string"
    }
  }
}

Customer

Fetch merchant customer information

Customer

Fetch customers

Fetch all customer information owned by merchant

first:

integer

Returns the first n elements from the list.

after:

string

Returns the elements in the list that come after the specified cursor.

last:

integer

Returns the last n elements from the list.

before:

string

Returns the elements in the list that come before the specified cursor.

token:

string

Access token from authentication operation

type:

string

Filter by plateform which use to contact

tagId:

string

Filter by tag

Example

Request Content-Types: application/json

Query

query customers($first: Int, $after: String, $last: Int, $before: String, $token: String!, $type: String, $tagId: String){
  customers(first: $first, after: $after, last: $last, before: $before, token: $token, type: $type, tagId: $tagId){
  }
}

Variables

{
  "first": "integer",
  "after": "string",
  "last": "integer",
  "before": "string",
  "token": "string",
  "type": "string",
  "tagId": "string"
}

Try it now

Successful operation

CustomerConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "customers": {}
  }
}

Customer

Fetch customer

Fetch customer information by id

id:

integer

Unique object reference number

token:

string

Access token from authentication operation

Example

Request Content-Types: application/json

Query

query customer($id: Int!, $token: String!){
  customer(id: $id, token: $token){
    address
    email
    id
    name
    note
    phone
    type
  }
}

Variables

{
  "id": "integer",
  "token": "string"
}

Try it now

Successful operation

Customer

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "customer": {
      "address": "string",
      "email": "string",
      "id": "string",
      "name": "string",
      "note": "string",
      "phone": "string",
      "type": "string"
    }
  }
}

Bank

Fetch bank account information

Bank

Fetch banks

Fetch all bank account information owned by merchant

first:

integer

Returns the first n elements from the list.

after:

string

Returns the elements in the list that come after the specified cursor.

last:

integer

Returns the last n elements from the list.

before:

string

Returns the elements in the list that come before the specified cursor.

token:

string

Access token from authentication operation

Example

Request Content-Types: application/json

Query

query bankAccounts($first: Int, $after: String, $last: Int, $before: String, $token: String!){
  bankAccounts(first: $first, after: $after, last: $last, before: $before, token: $token){
  }
}

Variables

{
  "first": "integer",
  "after": "string",
  "last": "integer",
  "before": "string",
  "token": "string"
}

Try it now

Successful operation