此组别内的文章
查看更多

绑定Cubyn API

      Cubyn API是将物流与Cubyn集成的最灵活的方法。

      特别是，它允许您：

  • 导入您的货运信息
  • 追踪您的货件：货件状态和追踪号
  • 收到有关每个投递状态更改的通知。

      您可以在此专用网站上找到有关API的所有文档：http：//developers.cubyn.com。

绑定Cubyn API

      为了绑定Cubyn API，必须首先将Cubyn API应用程序添加到您的空间。

      为此，请转到您的Cubyn帐户，然后按照以下步骤操作：

  1. 转到应用部分
  2. 点击+按钮
  3. 单击Cubyn API图标旁边的安装按钮
  4. 输入您希望显示在个人空间上的应用程序的名称
  5. 确认

EN_App_install_1.png

EN_app_install_2.png

EN_App_install_3.png

      要将您的服务与该应用程序绑定，您需要获取身份验证密钥，您将在Cubyn API应用程序的详细信息中找到它。
      您可以通过选择应用程序旁边的”扳手“，从“应用程序”选项卡访问，以获取将您的身份验证密钥。

EN_Cle_API_4.png

      进行此API连接后，您可以执行以下操作：

1- 发送库存

      为了发送库存，需要指明要装运的包装单位的数量，并向我们提供产品的详细信息：SKU，产品名称，条形码和数量。

      这些元素可在库存发货请求中指示的位置（可在此处找到）中输入。

{
 "packingUnits": 2,
 "items": [{
    "sku": "SKU1",
    "productName": "Name1",
    "barcode": "123456789",
    "quantity": 4
 },
 {
    "sku": "SKU2",
    "productName": "Name2",
    "barcode": "234567890",
    "quantity": 90
 }]
}

      您将收到与库存发货相关的入库清单 ID（pid）以及申报的包裹和产品的数量的回复。

{
 ...
 "pid": "184569",
 ...
 "declaredPackingUnits": 2,
 "receivedPackingUnits": 0,
 "completedPackingUnits": 0,
 "declaredItems": 94,
 "storedItems": 0,
 "createdAt": "2020-05-25T09:37:29.000Z",
 "updatedAt": "2020-05-25T09:37:29.000Z",
 "receiptStartedAt": null,
 "validatedAt": "2020-05-25T09:37:29.000Z",
 "completedAt": null,
 "deletedAt": null,
 ...
}

2- 追踪库存

      通过此处的关联查询，您可以实时追踪库存；该查询将以SKU展示各种信息，包括正在接收，可用，正在
[
 {
 ...
 "sku": "iPhone_10_32G_new",
 "sanitizedSku": "IPHONE-10-32G-NEW",
 "name": "iPhone 10 32G new",
 "isVirtual": false,
 "isBundle": false,
 "createdAt": "2020-05-07T14:59:45.000Z",
 "updatedAt": "2020-05-07T14:59:45.000Z",
 ...
 "stock": {
    "hadStockInbounded": true,
    "quantityAvailable": 7,
    "quantityOutbounded": 0,
    "quantityInbounding": 0,
    "quantityOutbounding": 1,
    ...
 },
 ...
 },
...
]

3- 创建一个包裹订单

      您需要提供有关每次装运收件人的不同信息，还需要提供产品的SKU以及要运送的任何订单的数量。可在此处获得创建货件所需的详细信息。

{ 
 "type":"SHIPMENT",
 "firstName":"Sophie", 
 "lastName":"Martin", 
 "items":[ 
 { 
    "reference":"SKU1", 
    "count":1 
 } 
 ], 
 "orderRef": "Order1", 
 "address":{ 
    "line1":"13 rue Lecourbe", 
    "zip":"75007", 
    "city":"Paris",
    "country":"France", 
    "additionalInformation":"code 9898" 
 },
 "value": 10.99
}

      发送请求后，它将返回给您有关货件详细信息的摘要以及相关信息。

{
 ...
 "trackingId": "CUB131958015",
 "status": "CREATED",
 ...
 "address": {
    "line1": "13 rue Lecourbe",
    "line2": "",
    "zip": "75007",
    "city": "Paris",
    "state": "",
    "country": "FR",
    "additionalInformation": "code 9898"
 },
 "firstName": "Sophie",
 "lastName": "Martin",
 "value": 10.99,
 "deliveryMode": "standard",
 "deliverySigned": false,
 "objectCount": 1,
 "insurance": 0,
 "isAdvalorem": false,
 "orderRef": "Order1",
 "createdAt": "2020-05-25T10:07:28.000Z",
 "updatedAt": "2020-05-25T10:07:28.000Z",
 ...
 "items": [
 {
 "reference": "SKU1",
 "count": 1
 }
 ],
 ...
}

4- 追踪您的货物（或特定包裹）

      最后，您可以使用此处找到的关联查询来追踪您的货运。

      在末尾输入ID，您将找到货件的详细信息，包括收件人的详细信息及其状态；不输入任何ID也可获取所有订单的完整信息。

 

5- Webhooks

      您还可以在Cubyn API应用程序的设置中添加Webhook的URL，我们可以将有关您的订单的信息发送到该Webhook。

EN_Webhook_5.png

      一旦您的货物在我们的仓库中有状态更新，就会触发信息发送。 您可以选择希望收到提示，该选择是在Cubyn API应用程序的设置中进行的。

EN_Webhook_6.png

      我们的系统将生成一个POST请求，其中包含三个主要元素：

  • 您的包裹触发的事件
  • API密钥
  • 包裹的详细信息

      这些不同元素的详细信息可在“追踪包裹”中 访问，可从此处访问。

      请注意：我们建议您以HTTPs的形式向我们提供一个Webhook URL，并经常比较API密钥与发送的请求中显示的API密钥，以保护系统安全。

      🚨 为了发送Wehbook，必须通过相同的API连接创建关联的订单。手动创建的订单不会出发Wehbooks的发动。

 

附件

1-将文件附加到您的投递订单

      在某些情况下，您需要将文件附加到您的投递订单中。在“指南”部分中，您会找到“包裹附件”一栏，可在此处访问，您可获取要执行的附加文件查询。该查询会对您的货件附加文件进行确认。

2- 建立Cubyn追踪页面

      Cubyn提供了一个追踪页面，该页面对于我们合作的所有承运人都是通用的，强烈建议使用。为此，您只需要创建您的追踪号，并转到追踪页面即可。

      您将在此此处到这些步骤的详细信息。

3- 随Cubyn Relay一起发货

      为了将包裹运送到Relay点，您需要指定relayPickupRef。这对应于所需Relay点的位置，我们建议您使用iframe进行选择。当前我们与Mondial Relais合作，您可以使用plugin选择中继点。

      有关集成的更多信息，请单击此处。

4- 在沙盒环境中测试

      Cubyn提供了一个沙盒环境，在此环境中，您可以在投入使用之前测试集成，可发送电子邮件至onboarding@cubyn.com以获取沙盒账号

      有关连接的更多信息，请单击此处.。

评论

0 条评论

文章评论已关闭。