API接口文档

OzBabies提供相应API帮助内部客人建立订单。API基于JSON Restful结构，请联系网站管理员获取API权限账户。

API endpoint列表：

  • Get  secure CSRF token - 获取CSRF token用于加强网站API连接安全
  • Get Products List - 获取当前商品列表
  • Get Logistic Provider List - 获取可用物流列表
  • Get User Store Credit - 获取用户网站credit
  • Create OzBabies Order - 建立订单

API 连接 authentication:

方式 - Basic Auth (Pass via HTTP header)
参数 - Username, Password (Account credential from ozbabies.com.au)


获取 secure CSRF token:

哈希字符串用于传入建立订单API
Request
Method GET
URL <domain.com>/rest/session/token
Header N/A
Parameter N/A

Response
Format JSON
Return     Error: {"message":"----"}
        404 - API resource not found
    Success:
        200 - <token> - String

 


Get Products List:

拿取当前商品列表

Request
Method GET
Url <domain.com>/api/v1/product_lists?_format=json
Header [
    "Content-Type": "application/json"
]
Parameter N/A
Example GET /api/v1/product_lists?_format=json HTTP/1.1
Host: ozbabies.com.au
Authorization: Basic HashString
Cache-Control: no-cache

Response
Format JSON
Return     Error: {"message":"----"}
        403 - permission denial
        404 - API resource not found
    Success:
        200 - data: [{
        "sku", - String
        "title", - String
        "price", - Double
        "available" - Boolean
    }, ...]

 


Get Logistic Provider List:

获取可用物流列表。

Request
Method GET
Url <domain.com>/api/v1/logistic_provider/list?_format=json
Header [
    "Content-Type": "application/json"
]
Parameter N/A
Example GET /api/v1/logistic_provider/list?_format=json HTTP/1.1
Host: ozbabies.com.au
Authorization: Basic HashString
Cache-Control: no-cache

Response
Format JSON
Return     Error: {"message":"----"}
        403 - permission denial
        404 - API resource not found
    Success:
        200 - data: [{
          "code", - String
          "title", - String
         }, ...]

 


Get User Store Credit:

获取用户网站credit。

Request
Method GET
Url <domain.com>/api/v1/store_credit?_format=json
Header [
    "Content-Type": "application/json"
]
Parameter N/A
Example GET /api/v1/store_credit?_format=json HTTP/1.1
Host: ozbabies.com.au
Authorization: Basic HashString
Cache-Control: no-cache

Response
Format JSON
Return     Error: {"message":"----"}
        403 - permission denial
        404 - API resource not found
    Success:
        200 - data: {
            "amount", - Float
            "currency", - String
          }

 

 

Create Order

建立代发订单接口

Request
Method POST
Url <domain.com>/api/v2/order/create?_format=json
Header [
    "Content-Type": "application/json",
    "X-CSRF-Token": <token>
]
Post Payload

{
  "logisticProvider": String - Optional(use EWE if user not specify a logisticProvider),
  "billingAddress": {
    "organization": String - Optional
    "line1": String - Mandatory
    "line2": String - Optional
    "suburb": String - Mandatory
    "city": String - Mandatory/Optional(only when states are major city in China)
    "state": String - Mandatory
    "country": String - Mandatory
    "postal": String - Mandatory
  }, -- 可为空或者省略
  "customerOrders": [{
    "senderName": String - Mandatory,
    "senderPhone": String - Mandatory,
    "receiverName": String - Mandatory,
    "receiverPhone": String - Mandatory,
    "shippingAddress": {
      "organization": String - Optional
      "line1": String - Mandatory
      "line2": String - Optional
      "suburb": String - Mandatory
      "city": String - Mandatory/Optional(only when states are major city in China)
      "state": String - Mandatory
      "country": String - Mandatory Note: Please use ISO short code
      "postal": String - Mandatory
    },
    "orderNotes": String - Optional
    "orderItems": [ //Same end customer, multiple products
        {
        "sku": Options - list from 'Get Product List' - Mandatory
        "qty": Options [1, 3, 6] - Mandatory
        "tracking_code": String - Optional
        },
        {
        "sku": Options - list from 'Get Product List' - Mandatory
        "qty": Options [1, 3, 6] - Mandatory
        "tracking_code": String - Optional
        },
        ... At least one
      ]
    }
    ... At least one
  ]
}

Response
Format JSON
Return

    Error: {"message":"----"}
        403 - permission denial
        404 - API resource not found
    Success:
        200 - data: [
                      'remoteOrderID': String,
                      'shipments': String
                      'removeOrderRef': String
                      'orderAmount': String
                 ]