Skip to content

jter/merchant-restful-api-docs

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
README.md
README.md
 
 
_config.yml
_config.yml
 
 

Repository files navigation

Shoppo Merchant API

Merchant API 是 Shoppo 为商户、ERP 的 API 对接提供的 API，对以下功能提供支持：

  • 获取、更新（TODO）商户信息；
  • 获取、更新商品信息；
  • 获取、更新订单信息；
  • 对接 Shoppo 物流；

API 请求地址

基本设置

在开始之前，请跟联系 Shoppo 的对接人员开通 API 服务。 API 服务开通后，您可以在 开发者页面 (正式环境，sandbox 环境) 获取到 商户ID 以及 API Key

  • 如果 API Key 没有刷新，请尝试注销重新登录

您可以使用下面的命令行指令来测试 API Key 的有效性：

$ curl {api key对应环境的请求地址}/api/merchant/health_check/ --header "merchantid: <商户ID>" --header "apikey: <API Key>"

有效的 API Key 将会收到如下 response：

Go <商户名称>! Go Shoppo!

此外，请注意以下几点：

  • 所有的数据均适用 UTF-8 编码；
  • 请发送 HTTPS 请求，我们不保证对 HTTP 协议的支持；
  • 每个请求的 header 都必须包括 merchantid 以及 apiKey；
  • 对于请求的 body，如果需要传内容，请以 json 格式进行编码传输;

错误信息

所有成功的 API 请求都将会返回一个 statusCode = 200 的 response。错误的请求将会以非 200 的代码返回，一般包含一个错误信息。比如：

$ curl https://api-sandbox.shoppo.com/api/merchant/health_check/ --header "merchantid: <merchant id>" --header "apikey: wrong-key" -i
HTTP/1.1 403 FORBIDDEN
Access-Control-Allow-Origin: *
Content-Type: application/json
Date: Mon, 30 Oct 2017 03:35:58 GMT
Server: nginx/1.12.1
Content-Length: 55
Connection: keep-alive

{
  "error": "Unauthorized request: invalid api key"
}

测试环境

在开发测试阶段，您可能不希望一些测试的请求影响到生产数据。此时请要求对接人员提供一个测试用的 商户ID 以及 API Key，并且将所有的测试请求发送到 https://api-sandbox.shoppo.com/。比如

$ curl https://api-sandbox.shoppo.com/api/merchant/health_check/ --header "merchantid: <商户ID>" --header "apikey: <API Key>"

如果您需要一些额外的测试数据，请发邮件到 Shoppo 的 API 对接邮箱说明您的数据需求。

API 接口列表

读取

/api/merchant/profile/ [GET]

获取当前商户信息。

参数：无

返回参数：

  • id (string!): 商户 ID
  • merchant_name (string!): 商户名
  • status (string!): VALID, PENDING_APPROVE, SUSPEND或者INVALID。其中只有VALID是在经营的商户状态。

参考 Response：

{
  "data": {
    "id": "gKXzYvzAm1QsZ",
    "merchant_name": "Shoppo Dev",
    "status": "VALID"
  }
}

/api/merchant/orders/ [GET]

读取当前商户订单。对于返回的order_items下列几种情况不能创建物流订单，当调用创建物流订单的API时候会报错

  • order_item的tracking_number不为空
  • order_item的status是CANCELLED, SHIPPED的情况下

参数：

  • bookmark (string?): 分页是使用的起始标示，相当于 offset。
  • limit (int?): 返回的 order 最大数量，默认 20。必须为一个 0 到 200 之间的整数。
  • time_created_from (timestamp?): 订单创建时间范围起点，类型为十位的 UTC 时间戳
  • time_created_to (timestamp?): 订单创建时间范围终点，类型为十位的 UTC 时间戳
  • status_in: 订单的状态，譬如：PAID。如果需要填多个，则按照英文逗号分隔，譬如：PAID,IN_PROGRESS。
    • 订单状态筛选说明
      • PAID: 用户已付款等待商户操作。注意，用户付款的订单在 2 小时 以内用户可以自由取消，请注意判断。
      • IN_PROGRESS: 订单已经部分发货。
      • SHIPPED: 订单内所有商品已发货。
      • DELIVERED: 用户手动点击收货。
      • CLOSED: 订单已关闭。
  • channel_code: 订单渠道号， 不同渠道号会有不同的物流操作以及相关政策
    • 可能的值
      • IN19A04
      • IN23A15
      • IN06A12
      • IN13A01
      • BD16A05
      • MY14A15
      • MY01A12
      • KE11A09
      • SG02A06
      • SG24A05
      • TH20A01
      • PK03A12
      • AE01A23
      • RU19A08
      • RU15A26
      • US19A08
      • NG03A18

返回参数：TODO

  • total (int!): 总订单数；
  • bookmark (string!): 分页时，下一次请求需要传入的参数；
  • orders ([Order]!): 订单列表，请注意在遇到非法的Order时列表中可能包含null（见下面的例子）

参考 Request：

https://api-sandbox.shoppo.com/api/merchant/orders/?limit=2&bookmark=fa7GD1JmmdOI1

参考 Response：

{
  "data": {
    "bookmark": "jzyGD1JmmdOI1",
    "orders": [
      null,
      {
        "buyer_id": "k7okizN7",
        "buyer_order_number": "26978695384001255400",
        "country_code": "US",
        "channel_code": "US19A08",
        "id": "jzyGD1JmmdOI1",
        "status": "IN_PROGRESS",
        "order_items": [
          {
            "id": "3V1q1JWqvb2tdW",
            "is_refunded": true,
            "product_snapshot_identifier":
              "test-prod-ea52ac4c5bd011e79332f45c89a3e2f9",
            "product_snapshot_name": "A dog",
            "quantity": 1,
            "refund_reason": "",
            "shipping_provider": null,
            "shipping_refunded": true,
            "sku_snapshot_identifier":
              "test-sku-ea52e05e5bd011e7b06bf45c89a3e2f9",
            "sku_snapshot_price": 171.31,
            "sku_snapshot_shipping_price": 5.5,
            "status": "PAID",
            "tracking_number": null,
            "wise_courier_code": null,
            "channel_code": "US19A08"
          },
          {
            "id": "6qvyvJWyx1VS5l",
            "is_refunded": false,
            "product_snapshot_identifier":
              "test-prod-ea54d47a5bd011e797c6f45c89a3e2f9",
            "product_snapshot_name": "A cat",
            "quantity": 1,
            "refund_reason": "",
            "shipping_provider": null,
            "shipping_refunded": false,
            "sku_snapshot_identifier":
              "test-sku-ea54fd805bd011e7ae35f45c89a3e2f9",
            "sku_snapshot_price": 107.37,
            "sku_snapshot_shipping_price": 1.0,
            "status": "PAID",
            "tracking_number": null,
            "wise_courier_code": null,
            "channel_code": "US19A08"
          }
        ],
        "order_time": "Mon, 10 Jul 2017 08:11:39 GMT",
        "order_total": 285.18,
        "shipping_address": {
          "address1": "1 Folsom St",
          "address2": "",
          "city": "San Francisco",
          "country": "United States",
          "phone_number": "3356432453",
          "recipient_name": "Test User",
          "state": "CA",
          "zipcode": "94106"
        }
      }
    ],
    "total": 90
  }
}

/api/merchant/order/<order ID>/ [GET]

读取单个商户订单信息。

参数：无

返回参数：一个Order。

参考 Request：

https://api-sandbox.shoppo.com/api/merchant/order/jzyGD1JmmdOI1/

参考 Response：

{
  "data": {
    "buyer_id": "0Vw2T5j7",
    "buyer_order_number": "23904323511825880199",
    "country_code": "US",
    "channel_code": "US19A08",
    "id": "pkyrw2qmmlXfn",
    "order_items": [
      {
        "id": "KvL2Lb12jnMTpw",
        "is_refunded": false,
        "product_snapshot_identifier":
          "test-prod-274ffb685a8511e78e2af45c89a3e2f9",
        "product_snapshot_name":
          "test prod name 274ffb685a8511e78e2af45c89a3e2f9",
        "quantity": 1,
        "refund_reason": "",
        "shipping_provider": null,
        "shipping_refunded": false,
        "sku_snapshot_identifier": "test-sku-27500cae5a8511e7812bf45c89a3e2f9",
        "sku_snapshot_price": 176.4,
        "sku_snapshot_shipping_price": 1.0,
        "status": "IN_FULFILLMENT",
        "tracking_number": null,
        "wise_courier_code": null,
        "channel_code": "US19A08"
      }
    ],
    "order_time": "Fri, 27 Oct 2017 05:43:20 GMT",
    "order_total": 177.4,
    "shipping_address": {
      "address1": "test",
      "address2": "est",
      "city": "test",
      "country": "United States",
      "phone_number": "3356432453",
      "recipient_name": "Test test",
      "state": "te",
      "zipcode": "53216"
    }
  }
}

/api/merchant/products/ [GET]

读取当前商户商品。

参数：

  • bookmark (string?): 分页是使用的起始标示，相当于 offset。
  • limit (int?): 返回的Product最大数量，默认 20。必须为一个 0 到 200 之间的整数。

返回参数：TODO

  • total (int!): 总商品数；
  • bookmark (string!): 分页时，下一次请求需要传入的参数；
  • products ([Product]!): 商品列表，请注意在遇到非法的Product时列表中可能包含null。

参考 Request：

https://api-sandbox.shoppo.com/api/merchant/products/?limit=1

参考 Response：

{
  "data": {
    "bookmark": "4YzNjz4KZOue",
    "products": [
      {
        "brand": "test brand",
        "category_id": "501010",
        "english_name": "english_name_declare",
        "chinese_name": "中文名",
        "cover_image_url":
          "https://cdn.shoppo.com/images/7c7066ea67bcdae2603ebc10dcc41a1a.JPEG",
        "cover_video_url": null,
        "description": "test prod description 5e5b952c5a5a11e7a145f45c89a3e2f9",
        "extra_image_urls": [
          "https://cdn.shoppo.com/images/1c7066fa67bcdae2603ebc10dcc41a1a.JPEG"
        ],
        "features": [],
        "id": "4YzNjz4KZOue",
        "identifier": "test-prod-5e5b952c5a5a11e7a145f45c89a3e2f9",
        "name": "test prod name 5e5b952c5a5a11e7a145f45c89a3e2f9",
        "rich_detail_sections": "Coming soon",
        "skus": [
          {
            "color": "red",
            "cover_image_url":
              "https://cdn.shoppo.com/images/34768a6a185ff5c76780dc99fb3140b8.JPEG",
            "enabled": true,
            "height": "8",
            "hs_code": "1234",
            "id": "pvmj64QXLDaux",
            "identifier": "test-sku-5e5d4f485a5a11e7a58df45c89a3e2f9",
            "inventory": 14,
            "length": "4",
            "material": "metal",
            "msrp": 174.44,
            "price": 164.44,
            "product_id": "4YzNjz4KZOue",
            "product_identifier": "test-prod-5e5b952c5a5a11e7a145f45c89a3e2f9",
            "shipping_price": 1.0,
            "shipping_time": "10-30 Days",
            "size": "S",
            "upc": "1237513718",
            "weight": "0.5",
            "width": "1"
          }
        ],
        "tags": [],
        "target_user_type": "ALL",
        "white_background_image_url": null,
        "has_battery": false,
        "has_liquid": false
      }
    ],
    "total": 347
  }
}

/api/merchant/products/ [POST]

创建商品

Type Description Required
name string 商品名称 ✅ Yes
identifier string 商户商品 ID ✅ Yes
english_name string 商品英文报关名 ✅ Yes
chinese_name string 商品中文报关名 ✅ Yes
cover_image_url string 商品主图链接, URL ✅ Yes
white_background_image_url string, URL 商品白色背景图片链接 No
extra_image_urls string [*-10] 商品细节图, URL No
description string 商品描述 ✅ Yes
brand string 商品品牌 No
features string [1-6] 产品特性 ✅ Yes
tags string [] 商品标签 No
target_user_type string 适用性别, ALL / MEN / WOMEN ✅ Yes
has_battery boolean 是否带电池，默认false No
has_liquid boolean 是否带液体，默认false No
skus [Sku] Sku 列表 ✅ Yes

参数：

返回参数：

  • 新创建的商品，请参考类型定义Product

参考 Request：

curl -X POST -s -H "Content-Type: application/json" -H "apikey: API_KEY" -H "merchantid: MERCHANT_ID" -d '{"identifier": "0.22207682727070244", "name": "product name", "english_name": "english_name_declare", "chinese_name": "\u5546\u54c1\u4e2d\u6587\u540d\u79f0", "cover_image_url": "https://cdn.shoppo.com/images/10f615395c677b7fc9a56a75cf0f3bad.JPEG", "white_background_image_url": "https://cdn.shoppo.com/images/e76ffd110fb3031a325899991feb844f.JPEG", "description": "description", "features": ["feature 1", "feature 2"], "brand": "shoppo", "tags": ["beauty", "fashion"], "target_user_type": "MEN", "extra_image_urls": ["https://cdn.shoppo.com/images/10f615395c677b7fc9a56a75cf0f3bad.JPEG", "https://cdn.shoppo.com/images/e76ffd110fb3031a325899991feb844f.JPEG"], "category_id": "5010101", "has_battery": false, "has_liquid": false, "skus": [{"identifier": "0.9290457919886833", "cover_image_url": "https://cdn.shoppo.com/images/10f615395c677b7fc9a56a75cf0f3bad.JPEG", "price": 1.11, "inventory": 10, "shipping_price": 0.11, "msrp": 2.2, "color": "white", "size": "L", "length": "1", "height": "2.5", "width": "1.1", "weight": "0.1", "material": "plastic", "upc": "xxxxxxx", "hs_code": "aaaaa", "shipping_time": "12-15"}]}' https://api-sandbox.shoppo.com/api/merchant/products/

参考 Response：

{
  "data": {
    "brand": "shoppo",
    "category_id": "5010101",
    "english_name": "english_name_declare",
    "chinese_name": "\u5546\u54c1\u4e2d\u6587\u540d\u79f0",
    "cover_image_url":
      "https://cdn.shoppo.com/images/2999d5a2775bf6bf773f30382f3718d9.JPEG",
    "cover_video_url": null,
    "description": "description",
    "extra_image_urls": [
      "https://cdn.shoppo.com/images/2999d5a2775bf6bf773f30382f3718d9.JPEG",
      "https://cdn.shoppo.com/images/719444693b58750ad7b88a8318d68353.JPEG"
    ],
    "features": ["feature 1", "feature 2"],
    "id": "Mzjq1jXGNqH2",
    "identifier": "0.22207682727070244",
    "name": "product name",
    "rich_detail_sections": "Coming soon",
    "skus": [
      {
        "color": "white",
        "cover_image_url":
          "https://cdn.shoppo.com/images/2999d5a2775bf6bf773f30382f3718d9.JPEG",
        "enabled": false,
        "height": "2.5",
        "hs_code": "aaaaa",
        "id": "5w3kXrAVlqdHA",
        "identifier": "0.9290457919886833",
        "inventory": 10,
        "length": "1",
        "material": "plastic",
        "msrp": 2.2,
        "price": 1.11,
        "product_id": "Mzjq1jXGNqH2",
        "product_identifier": "0.22207682727070244",
        "shipping_price": 0.11,
        "shipping_time": "12-15",
        "size": "L",
        "upc": "xxxxxxx",
        "weight": "0.1",
        "width": "1.1"
      }
    ],
    "tags": ["beauty", "fashion"],
    "target_user_type": "MEN",
    "white_background_image_url":
      "https://cdn.shoppo.com/images/719444693b58750ad7b88a8318d68353.JPEG",
    "has_battery": false,
    "has_liquid": false
  }
}

/api/merchant/product/<merchant product identifier>/ [GET]

通过商户商品 ID 来读取单个商户商品信息。

参数：无

返回参数：一个Product。

参考 Request：

https://api-sandbox.shoppo.com/api/merchant/product/test-prod-5e5b952c5a5a11e7a145f45c89a3e2f9/

参考 Response：

{
  "data": {
    "brand": "test brand",
    "category_id": "501010",
    "english_name": "english_name_declare",
    "chinese_name": "中文报关名",
    "cover_image_url":
      "https://cdn.shoppo.com/images/7c7066ea67bcdae2603ebc10dcc41a1a.JPEG",
    "cover_video_url": null,
    "description": "test prod description 5e5b952c5a5a11e7a145f45c89a3e2f9",
    "extra_image_urls": [
      "https://cdn.shoppo.com/images/1c7066fa67bcdae2603ebc10dcc41a1a.JPEG"
    ],
    "features": [],
    "id": "4YzNjz4KZOue",
    "identifier": "test-prod-5e5b952c5a5a11e7a145f45c89a3e2f9",
    "name": "test prod name 5e5b952c5a5a11e7a145f45c89a3e2f9",
    "rich_detail_sections": "Coming soon",
    "skus": [
      {
        "color": "red",
        "cover_image_url":
          "https://cdn.shoppo.com/images/34768a6a185ff5c76780dc99fb3140b8.JPEG",
        "enabled": true,
        "height": "8",
        "hs_code": "1234",
        "id": "pvmj64QXLDaux",
        "identifier": "test-sku-5e5d4f485a5a11e7a58df45c89a3e2f9",
        "inventory": 14,
        "length": "4",
        "material": "metal",
        "msrp": 174.44,
        "price": 164.44,
        "product_id": "4YzNjz4KZOue",
        "product_identifier": "test-prod-5e5b952c5a5a11e7a145f45c89a3e2f9",
        "shipping_price": 1.0,
        "shipping_time": "10-30 Days",
        "size": "S",
        "upc": "1237513718",
        "weight": "0.5",
        "width": "1"
      }
    ],
    "tags": [],
    "target_user_type": "ALL",
    "white_background_image_url": null,
    "has_battery": false,
    "has_liquid": false
  }
}

/api/merchant/product/<merchant product identifier>/ [POST, PUT]

通过商户商品 ID 修改商品信息。

参数：

Type Description Required
name string 商品名称 No
english_name string 商品英文报关名 No
chinese_name string 商品中文报关名 No
cover_image_url string 商品主图链接, URL No
extra_image_urls string [*-10] 商品细节图, URL No
white_background_image_url string 商品白色背景图, URL No
description string 商品描述 No
brand string 商品品牌 No
features string [1-6] 产品特性 No
tags string [] 商品标签 No
target_user_type string 适用性别, ALL / MEN / WOMEN No
has_battery boolean 是否带电池，默认false No
has_liquid boolean 是否带液体，默认false No

返回参数：Product。

参考 Request：

curl -X POST -s -H "Content-Type: application/json" -H "apikey: API_KEY" -H "merchantid: MERCHANT_ID" -d '{"name": "new name from api"}' https://api-sandbox.shoppo.com/api/merchant/product/0.09917838114011723/

参考 Response：

{
  "data": {
    "brand": "shoppo",
    "category_id": "5010101",
    "english_name": "english_name_declare",
    "chinese_name": "\u5546\u54c1\u4e2d\u6587\u540d\u79f0",
    "cover_image_url":
      "https://cdn.shoppo.com/images/2999d5a2775bf6bf773f30382f3718d9.JPEG",
    "cover_video_url": null,
    "description": "description",
    "extra_image_urls": [
      "https://cdn.shoppo.com/images/2999d5a2775bf6bf773f30382f3718d9.JPEG",
      "https://cdn.shoppo.com/images/719444693b58750ad7b88a8318d68353.JPEG"
    ],
    "features": ["feature 1", "feature 2"],
    "id": "WZ5Le5RxNjU4",
    "identifier": "0.09917838114011723",
    "name": "new name from api",
    "rich_detail_sections": "Coming soon",
    "skus": [
      {
        "color": "white",
        "cover_image_url":
          "https://cdn.shoppo.com/images/2999d5a2775bf6bf773f30382f3718d9.JPEG",
        "enabled": false,
        "height": "2.5",
        "hs_code": "aaaaa",
        "id": "kAmwdzaXLryIX",
        "identifier": "0.9343675469927027",
        "inventory": 10,
        "length": "1",
        "material": "plastic",
        "msrp": 2.2,
        "price": 1.11,
        "product_id": "WZ5Le5RxNjU4",
        "product_identifier": "0.09917838114011723",
        "shipping_price": 0.11,
        "shipping_time": "12-15",
        "size": "L",
        "upc": "xxxxxxx",
        "weight": "0.1",
        "width": "1.1"
      },
      {
        "color": "white",
        "cover_image_url":
          "https://cdn.shoppo.com/images/2999d5a2775bf6bf773f30382f3718d9.JPEG",
        "enabled": false,
        "height": "2.5",
        "hs_code": "aaaaa",
        "id": "Ne5AXKByjEpu1",
        "identifier": "0.09088102182121438",
        "inventory": 10,
        "length": "1",
        "material": "plastic",
        "msrp": 2.2,
        "price": 1.11,
        "product_id": "WZ5Le5RxNjU4",
        "product_identifier": "0.09917838114011723",
        "shipping_price": 0.11,
        "shipping_time": "12-15",
        "size": "L",
        "upc": "xxxxxxx",
        "weight": "0.1",
        "width": "1.1"
      }
    ],
    "tags": ["beauty", "fashion"],
    "target_user_type": "MEN",
    "white_background_image_url":
      "https://cdn.shoppo.com/images/719444693b58750ad7b88a8318d68353.JPEG",
    "has_battery": false,
    "has_liquid": false
  }
}

/api/merchant/product/<product id>/status/<status: enabled, disabled> [POST, PUT]

通过 Product ID 来上下架整个商品。 注意，这个接口将会修改整个商品下关联的所有 SKU 的上下架状态。

参数说明 product_id -> 通过 Product 接口获取到的 id 字段 status -> enabled 或者 disabled，分别代表上架或者下架

返回结果：修改后的 Product

参考 Request:

https://api-sandbox.shoppo.com/api/merchant/product/4YzNjz4KZOue/status/enabled/

参考 Response:

{
  "data": {
    "brand": "test brand",
    "category_id": "501010",
    "english_name": "english_name_declare",
    "chinese_name": "中文名",
    "cover_image_url":
      "https://cdn.shoppo.com/images/7c7066ea67bcdae2603ebc10dcc41a1a.JPEG",
    "cover_video_url": null,
    "description": "test prod description 5e5b952c5a5a11e7a145f45c89a3e2f9",
    "extra_image_urls": [
      "https://cdn.shoppo.com/images/1c7066fa67bcdae2603ebc10dcc41a1a.JPEG"
    ],
    "features": [],
    "id": "4YzNjz4KZOue",
    "identifier": "test-prod-5e5b952c5a5a11e7a145f45c89a3e2f9",
    "name": "test prod name 5e5b952c5a5a11e7a145f45c89a3e2f9",
    "rich_detail_sections": "Coming soon",
    "skus": [
      {
        "color": "red",
        "cover_image_url":
          "https://cdn.shoppo.com/images/34768a6a185ff5c76780dc99fb3140b8.JPEG",
        "enabled": true,
        "height": "8",
        "hs_code": "1234",
        "id": "pvmj64QXLDaux",
        "identifier": "test-sku-5e5d4f485a5a11e7a58df45c89a3e2f9",
        "inventory": 14,
        "length": "4",
        "material": "metal",
        "msrp": 174.44,
        "price": 164.44,
        "product_id": "4YzNjz4KZOue",
        "product_identifier": "test-prod-5e5b952c5a5a11e7a145f45c89a3e2f9",
        "shipping_price": 1.0,
        "shipping_time": "10-30 Days",
        "size": "S",
        "upc": "1237513718",
        "weight": "0.5",
        "width": "1"
      }
    ],
    "tags": [],
    "target_user_type": "ALL",
    "white_background_image_url": null,
    "has_battery": false,
    "has_liquid": false
  }
}

/api/merchant/product/<merchant product identifier>/skus/ [POST]

商品添加 Sku

参数：

Type Description Required
identifier string Sku 商户自定义 ID ✅ Yes
cover_image_url string Sku 主图链接, URL ✅ Yes
color string 颜色 ✅ Yes
price number 单价, >= 0 ✅ Yes
msrp number 吊牌价, >= 0 No
inventory integer 库存数量, >= 0 ✅ Yes
shipping_price number 运费, >= 0 No
shipping_time string 送货时间(天)，格式为<最少天数>-<最多天数> No
size string 尺寸 ✅ Yes
weight string 重量，默认单位为磅 No
length string 长，默认单位为 inch No
width string 宽，默认单位为 inch No
height string 高，默认单位为 inch No
upc string 商品统一标示号 No
hs_code string 海关编码 No

返回参数：一个Sku。

参考 Request：

curl -X POST -s -H "Content-Type: application/json" -H "apikey: API_KEY" -H "merchantid: MERCHANT_ID" -d '{"identifier": "0.20843588399138824", "cover_image_url": "https://cdn.shoppo.com/images/10f615395c677b7fc9a56a75cf0f3bad.JPEG", "price": 1.11, "inventory": 10, "shipping_price": 0.11, "msrp": 2.2, "color": "white", "size": "L", "length": "1", "height": "2.5", "width": "1.1", "weight": "0.1", "material": "plastic", "upc": "xxxxxxx", "hs_code": "aaaaa", "shipping_time": "12-15"}' https://api-sandbox.shoppo.com/api/merchant/product/10927/skus/

参考 Response：

{
  "data": {
    "color": "white",
    "cover_image_url":
      "https://cdn.shoppo.com/images/2999d5a2775bf6bf773f30382f3718d9.JPEG",
    "enabled": false,
    "height": "2.5",
    "hs_code": "aaaaa",
    "id": "RmpMdQNXEGKfq",
    "identifier": "0.20843588399138824",
    "inventory": 10,
    "length": "1",
    "material": "plastic",
    "msrp": 2.2,
    "price": 1.11,
    "product_id": "mREDzEAQr6iq",
    "product_identifier": "10927",
    "shipping_price": 0.11,
    "shipping_time": "12-15",
    "size": "L",
    "upc": "xxxxxxx",
    "weight": "0.1",
    "width": "1.1"
  }
}

/api/merchant/sku/<merchant sku identifier>/ [GET]

通过商户 SKU ID 来读取单个 SKU 的信息。

参数：无

返回参数：一个Sku。

参考 Request：

https://api-sandbox.shoppo.com/api/merchant/sku/test-sku-5e5d4f485a5a11e7a58df45c89a3e2f9/

参考 Response：

{
  "data": {
    "color": "red",
    "cover_image_url":
      "https://cdn.shoppo.com/images/34768a6a185ff5c76780dc99fb3140b8.JPEG",
    "enabled": true,
    "height": null,
    "hs_code": null,
    "id": "pvmj64QXLDaux",
    "identifier": "test-sku-5e5d4f485a5a11e7a58df45c89a3e2f9",
    "inventory": 14,
    "length": null,
    "material": null,
    "msrp": 174.44,
    "price": 164.44,
    "product_id": "4YzNjz4KZOue",
    "product_identifier": "test-prod-5e5b952c5a5a11e7a145f45c89a3e2f9",
    "shipping_price": 1.0,
    "shipping_time": "10-30 Days",
    "size": "S",
    "upc": "",
    "weight": null,
    "width": null
  }
}

/api/merchant/sku/<merchant sku identifier>/ [POST, PUT]

修改单个 SKU 的基本信息。

参数：

Type Description Required
cover_image_url string Sku 主图链接 No
color string 颜色 No
price number 单价 No
msrp number 吊牌价 No
inventory integer 库存数量 No
shipping_price number 运费 No
shipping_time string 送货时间(天)，格式为<最少天数>-<最多天数> No
size string 尺寸 No
weight string 重量，默认单位为磅 No
length string 长，默认单位为 inch No
width string 宽，默认单位为 inch No
height string 高，默认单位为 inch No
upc string 商品统一标示号 No
hs_code string 海关编码 No

返回结果：修改后的 SKU 数据 参考 Request:

curl -X POST --header "merchantid: <商户ID>" --header "apikey: <API Key> https://api-sandbox.shoppo.com/api/merchant/sku/test-sku-5e5d4f485a5a11e7a58df45c89a3e2f9/ -d '{"inventory": 15}'

参考 Response:

{
  "data": {
    "color": "red",
    "cover_image_url":
      "https://cdn.shoppo.com/images/34768a6a185ff5c76780dc99fb3140b8.JPEG",
    "enabled": true,
    "height": null,
    "hs_code": null,
    "id": "pvmj64QXLDaux",
    "identifier": "test-sku-5e5d4f485a5a11e7a58df45c89a3e2f9",
    "inventory": 15,
    "length": null,
    "material": null,
    "msrp": 174.44,
    "price": 164.44,
    "product_id": "4YzNjz4KZOue",
    "product_identifier": "test-prod-5e5b952c5a5a11e7a145f45c89a3e2f9",
    "shipping_price": 1.0,
    "shipping_time": "10-30 Days",
    "size": "S",
    "upc": "",
    "weight": null,
    "width": null
  }
}

/api/merchant/sku/<sku id>/status/<status: enabled, disabled> [POST, PUT]

修改单个 SKU 的上下架状态。 参数：

  • sku id: 通过 product 或者 sku 接口获取到的 sku 数据的 id 字段
  • status: enabled 或者 disabled，分别表示上架和下架状态

返回结果：修改后的 SKU 数据 参考 Request:

https://api-sandbox.shoppo.com/api/merchant/sku/pvmj64QXLDaux/status/enabled/

参考 Response:

{
  "data": {
    "color": "red",
    "cover_image_url":
      "https://cdn.shoppo.com/images/34768a6a185ff5c76780dc99fb3140b8.JPEG",
    "enabled": true,
    "height": null,
    "hs_code": null,
    "id": "pvmj64QXLDaux",
    "identifier": "test-sku-5e5d4f485a5a11e7a58df45c89a3e2f9",
    "inventory": 14,
    "length": null,
    "material": null,
    "msrp": 174.44,
    "price": 164.44,
    "product_id": "4YzNjz4KZOue",
    "product_identifier": "test-prod-5e5b952c5a5a11e7a145f45c89a3e2f9",
    "shipping_price": 1.0,
    "shipping_time": "10-30 Days",
    "size": "S",
    "upc": "",
    "weight": null,
    "width": null
  }
}

/api/merchant/channel-courier-config/ [GET]

目前部分渠道 (channel_code) 的订单，需要商户先获取单号，而部分不需要。这里提供了一个接口，返回相应的配置。表明哪些渠道需要生成单号，以及对应的物流方式代码有哪些。该接口可以直接调用，不需要接口认证

  • channel_code不在返回结果里的订单，不需要获取单号
  • 如果某个channel_code对应的物流方式只有一个, 则商户在调用 create-logistics-order 的时候不需要传courier_code, 系统会自动填上对应的 courier_code , 反之则需要，因为系统不知道应该选哪种物流方式

参考 Response:

{
  "SG02A06": [
    "EUB_EMS"
  ], 
  "US19A08": [
    "SHANGHAI_EMS"
  ]
}

修改

/api/merchant/create-logistics-order/ [POST, PUT]

OrderItem 自动生成面单号，多个 order item 只能属于同一个商户订单，每次请求会生成一个新的面单号，对于部分来自印度的订单，已经指定了物流渠道，不需要调用该接口，得到面单号；如果调用，会提示错误; 如果 order item的状态是CANCELLED，�SHIPPED状态下，如果调用，也会提示错误，遇到这种 order item请过滤或者跳过处理。

参数：

  • courier_code(String): 物流方式代码, Enum 如果某渠道只有一种物流方式，则这个参数不需要传
    • PEKING_EMS, 物流方式名称 SHOPPO - Post，支持美国地区订单
    • OFFLINE_EMS，物流方式名称 SHOPPO - E邮宝，支持美国地区订单
    • SHANGHAI_EMS，物流方式名称 SHOPPO - 印度，用于印度地区订单
    • SHANGHAI_EMS，物流方式名称 SHOPPO - 马来西亚，用于马来西亚地区订单
    • SHOPPO_EXPRESS, 物流方式名称 SHOPPO - 国内中转，用于肯尼亚地区，孟加拉，部分印度地区的订单
    • EUB_EMS, 物流方式名称 SHOPPO - E邮宝2 用于澳大利亚、巴西、马来西亚、新加坡、印度尼西亚
  • registered(Boolean): 是否是挂号物流，默认值是false
  • order_item_ids([String]): 要生成面单号的 order items id 列表，这些 order item 会使用同一个包裹发货；如果需要用多个包裹发货，需要拆成多次请求，获取多个面单号。
  • order_item_to_chinese_names([Object]): 必填 order_item_id 到 中文报关名称 的映射。系统会使用这里填写的中文名称作为 中文报关名称 ，如果这里没有填写会报错 。

返回参数：order item 列表

参考 Request：

https://api-sandbox.shoppo.com/api/merchant/create-logistics-order/

参考 Payload:

{
  "courier_code": "",
  "registered": false,
  "order_item_ids": ["mEDWDgOWK8gc6g", "pRwWwg8WOeet6d"],
  "order_item_to_chinese_names": {
    "mEDWDgOWK8gc6g": "中文名称"
  }
}

说明： 这个请求中，返回的面单将自动绑定两个 Order Item 。同时，因为在 order_item_to_chinese_names 中只填写了部分 Order Item 的中文报关名称信息，所以 mEDWDgOWK8gc6g 这个 Order Item 将使用这里填写的中文名称，而 pRwWwg8WOeet6d 这个 Order Item 将使用其对应的商品的中文名称。

参考 Response:

{
  "data": {
    "order_items": [
      {
        "id": "mEDWDgOWK8gc6g",
        "is_refunded": false,
        "product_snapshot_identifier":
          "test-prod-5e5dc7525a5a11e7beb5f45c89a3e2f9",
        "product_snapshot_name":
          "test prod name 5e5dc7525a5a11e7beb5f45c89a3e2f9",
        "quantity": 1,
        "refund_reason_type": null,
        "shipping_provider": "wise-express",
        "shipping_refunded": false,
        "sku_snapshot_identifier": "test-sku-5e5de7ac5a5a11e79e6bf45c89a3e2f9",
        "sku_snapshot_price": 111.62,
        "sku_snapshot_shipping_price": 2.0,
        "status": "IN_FULFILLMENT",
        "tracking_number": "UG856257945CN",
        "wise_courier_code": "1"
      },
      {
        "id": "pRwWwg8WOeet6d",
        "is_refunded": false,
        "product_snapshot_identifier":
          "test-prod-124c234c5a5d11e793a3f45c89a3e2f9",
        "product_snapshot_name":
          "test prod name 124c234c5a5d11e793a3f45c89a3e2f9",
        "quantity": 1,
        "refund_reason_type": null,
        "shipping_provider": "wise-express",
        "shipping_refunded": false,
        "sku_snapshot_identifier": "test-sku-124c72d25a5d11e7850ef45c89a3e2f9",
        "sku_snapshot_price": 158.18,
        "sku_snapshot_shipping_price": 5.5,
        "status": "IN_FULFILLMENT",
        "tracking_number": "UG856257945CN",
        "wise_courier_code": "9901"
      }
    ]
  }
}

/api/merchant/download-logistics-stamp-pdf/ [POST]

下载多个 OrderItem 的物流面单，会返回一个 PDF 链接，下载 PDF 然后打印面单；一次最多能提交 100 个 order items。

参数：

  • order_item_ids([String]): 要打印面单的 order items id 列表。

返回参数：download_url，物流面单 PDF 链接

参考 Request：

https://api-sandbox.shoppo.com/api/merchant/download-logistics-stamp-pdf/

参考 Payload:

{
  "order_item_ids": ["mEDWDgOWK8gc6g", "pRwWwg8WOeet6d"]
}

参考 Response:

{
  "data": {
    "download_url":
      "http://www.shwise.cn/apitopdf.asp?oids=98F97470-AB9A-4244-91F7-FD04E9786973101"
  }
}

/api/merchant/order_item/<order item ID>/ [POST, PUT]

修改单个商户订单信息。注意，仅修改提供的参数。

参数：

  • tracking_number (String): 物流面单号。请注意面单号仅能够在该订单还未发货（status=SHIPPED）之前修改，发货之后无法通过 API 修改面单号。此外，我们仅支持几家常用的物流提供商，如果您的物流单号无法被识别，请联系 Shoppo 的客服人员解决。
  • shipping_provider (String): 物流商名称（比如 EMS, China Post），注意shipping_provider必须和tracking_number同时修改。

返回参数：一个OrderItem。

参考 Request：

https://api-sandbox.shoppo.com/api/merchant/order_item/KvL2Lb12jnMTpw/

参考 Payload:

{
  "tracking_number": "31837953231",
  "shipping_provider": "China Post"
}

参考 Response:

{
  "data": {
    "id": "KvL2Lb12jnMTpw",
    "is_refunded": false,
    "product_snapshot_identifier": "test-prod-274ffb685a8511e78e2af45c89a3e2f9",
    "product_snapshot_name": "test prod name 274ffb685a8511e78e2af45c89a3e2f9",
    "quantity": 1,
    "refund_reason": "",
    "shipping_provider": "China Post",
    "shipping_refunded": false,
    "sku_snapshot_identifier": "test-sku-27500cae5a8511e7812bf45c89a3e2f9",
    "sku_snapshot_price": 176.4,
    "sku_snapshot_shipping_price": 1.0,
    "status": "IN_FULFILLMENT",
    "tracking_number": "31837953231",
    "wise_courier_code": "1"
  }
}

/api/merchant/order_items/ship/ [POST, PUT]

将多个OrderItem标记为已发货。

参数：

  • order_item_ids ([String!]!): 发货的OrderItemID 列表。注意，仅有PAID和IN_FULFILLMENT状态、并且已经有合法tracking_number的订单可以发货。

返回参数：已发货的OrderItem列表。

参考 Request：

https://api-sandbox.shoppo.com/api/merchant/order_items/ship/

参考 Payload:

{
  "order_item_ids": ["KvL2Lb12jnMTpw"]
}

参考 Response:

{
  "data": {
    "order_items": [
      {
        "id": "KvL2Lb12jnMTpw",
        "is_refunded": false,
        "product_snapshot_identifier":
          "test-prod-274ffb685a8511e78e2af45c89a3e2f9",
        "product_snapshot_name":
          "test prod name 274ffb685a8511e78e2af45c89a3e2f9",
        "quantity": 1,
        "refund_reason": "",
        "shipping_provider": "China Post",
        "shipping_refunded": false,
        "sku_snapshot_identifier": "test-sku-27500cae5a8511e7812bf45c89a3e2f9",
        "sku_snapshot_price": 176.4,
        "sku_snapshot_shipping_price": 1.0,
        "status": "IN_FULFILLMENT",
        "tracking_number": "31837953231",
        "wise_courier_code": "1"
      }
    ]
  }
}

/api/merchant/order_item/<order item ID>/refund/ [POST, PUT]

将单个OrderItem退款。注意，refund 并不会改变OrderItem的状态。一个已经退款的OrderItem不能被重复退款（除非第一次没有退运费，第二次退运费）。

参数：

  • refund_shipping (Boolean!): 是否退运费。注意，一般情况下，未发货的订单一定要求退运费。
  • refund_reason_type (String!)：退款原因。OUT_OF_STOCK还是BAD_SHIPPING_ADDRESS还是AGREEMENT_WITH_USER。

返回参数：退款的 order item。

参考 Request：

https://api-sandbox.shoppo.com/api/merchant/order_item/KvL2Lb12jnMTpw/refund

参考 Payload:

{
  "refund_shipping": true,
  "refund_reason_type": "OUT_OF_STOCK"
}

参考 Response:

{
  "data": {
    "id": "KvL2Lb12jnMTpw",
    "is_refunded": true,
    "product_snapshot_identifier": "test-prod-274ffb685a8511e78e2af45c89a3e2f9",
    "product_snapshot_name": "test prod name 274ffb685a8511e78e2af45c89a3e2f9",
    "quantity": 1,
    "refund_reason": "",
    "shipping_provider": "China Post",
    "shipping_refunded": true,
    "sku_snapshot_identifier": "test-sku-27500cae5a8511e7812bf45c89a3e2f9",
    "sku_snapshot_price": 176.4,
    "sku_snapshot_shipping_price": 1.0,
    "status": "IN_FULFILLMENT",
    "tracking_number": "31837953231",
    "wise_courier_code": "1"
  }
}

/api/merchant/supported-couriers/ 获取支持的物流方式信息

获取当前系统中支持的物流方式以及对应的说明。其中，code 字段为 API 接受的格式，name 为对应方式的名称/说明。

参考 Request:

curl -X GET -H 'merchantid:<MerchantID>' -H 'apikey:<ApiKey>' -H 'mimetype:Application/json' 'https://api.shoppo.com/api/merchant/supported-couriers/'

参考 Response:

{
  "data": [
    {
      "code": "sunyou",
      "name": "Sunyou / \u987a\u53cb"
    },
    {
      "code": "amazon-fba-us",
      "name": "Amazon FBA USA"
    },
    {
      "code": "ppbyb",
      "name": "PayPal Package"
    },
    {
      "code": "4px",
      "name": "4PX"
    },
    {
      "code": "usps",
      "name": "USPS"
    },
    {
      "code": "yanwen",
      "name": "Yanwen"
    },
    {
      "code": "china-ems",
      "name": "China EMS (ePacket)"
    },
    {
      "code": "dhl",
      "name": "DHL Express"
    },
    {
      "code": "ups",
      "name": "UPS"
    },
    {
      "code": "yunexpress",
      "name": "Yun Express"
    },
    {
      "code": "fedex",
      "name": "FedEx"
    },
    {
      "code": "china-post",
      "name": "China Post"
    },
    {
      "code": "wise-express",
      "name": "Wise Express"
    }
  ]
}

类型定义

Order

一个订单。

Field name Type Description
id String! 订单 ID
order_time DateTime! 下单时间
shipping_address ShippingAddress! 送货地址
order_total float! 订单金额（美元）
buyer_id String! 买家 ID
buyer_order_number String! 买家订单号（显示给买家的一个数字订单号）
order_items List[OrderItem!]! 订单商品列表
country_code String! 订单来源国家码

OrderItem

一个订单商品。注意：所有订单中的商品、地址都是一个快照，不会由于商家修改实际商品而变化。所以相关变量名中都加入了snapshot关键字。

Field name Type Description
id String! 订单商品 ID（注：并不是商品 ID）
quantity Int! 购买数量
sku_snapshot_identifier String! 所购买 Sku 的商户自定义 ID
sku_snapshot_price float! 所购买 Sku 的价格（美元）
sku_snapshot_shipping_price float! 所购买 Sku 的运费价格（美元）
product_snapshot_identifier String! 所购买 Product 的商户自定义 ID
product_snapshot_name String! 所购买 Product 的名称
tracking_number String 面单号
shipping_provider String 物流提供商
status String! PAID, IN_FULFILLMENT, SHIPPED, CANCELLED或者DELIVERED。其中PAID状态会在 2 小时候自动变成IN_FULFILLMENT
is_refunded Boolean! 是否被退款
shipping_refunded Boolean 是否退了运费
refund_reason String 退款原因

ShippingAddress

一个地址。

Field name Type Description
recipient_name String! 收件人姓名
address1 String! 第一行地址
address2 String! 第二行地址
city String! 城市
state String! 州或者省
country String! 国家
zipcode String! 邮政编码
phone_number String! 收件人电话

Product

一个商品。

Field name Type Description
id String! 商品 ID
identifier String! 商户自定义的商品 ID
cover_image_url String! 商品主图链接
cover_video_url String 商品视频链接
white_background_image_url String! 白色背景图链接
name String! 商品名
english_name String! 商品英文报关名
chinese_name String! 商品中文报关名
description String! 商品描述
features List[String!]! 商品特性。将通过列表的形式显示给用户
brand String 品牌
tags List[String!]! 商品标签，用于优化搜索和推荐
category_id String! 商品分类号
extra_image_urls List[String!]! 更多商品图片
rich_detail_sections ? TODO
target_user_type String! MEN, WOMEN或者ALL。错误的标注可能导致商品被自动下架。
skus List[Sku!]! 商品的子 Sku 列表

Sku

一个 Sku。

Field name Type Description
id String! SkuID
identifier String! 商户自定义的 SkuID
cover_image_url String! Sku 主图
product_id String! 商品 ID
product_identifier String! 商户自定义的商品 ID
color String! 颜色，不能为空
size String! 尺寸，不能为空
inventory Int! 库存
price float! 价格，美元
shipping_price float! 运费价格，美元
msrp float! 制造商建议售价
shipping_time String! 送货时间（天），格式为<最少天数>-<最多天数>
upc String! 商品统一标示号，用于推荐。也就是商品标签上的扫描码
enabled Boolean! 是否上架
length String! 长，纯数字则默认 inch
width String! 宽，纯数字则默认 inch
height String! 高，纯数字则默认 inch
weight String! 重量，纯数字则默认单位磅
hs_code String! 海关编码，用于报关
material String! 材质

About

Documentation & Demo of Shoppo merchant restful API

shoppo.github.io/merchant-restful-api-docs/

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published