跳转到主要内容
POST
/
api
/
ReturnShipment
/
createReturnShipment
Create return shipment
curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/ReturnShipment/createReturnShipment \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "serviceTypeCode": "fedex_ground",
  "orderTitle": "Return Label Title",
  "orderNumber": "123123",
  "totalValueCurrency": "usd",
  "shipment": {
    "shipToWarehouseId": 2,
    "boxType": "cus",
    "sellerReferenceNumber": "<string>",
    "shipFrom": {
      "country": "usa",
      "contactName": "Your name",
      "phone": "15622708183",
      "email": "user@example.com",
      "fax": "<string>",
      "street1": "Some address line 1",
      "street2": "Some address line 2",
      "street3": "<string>",
      "state": "tx",
      "city": "Houston",
      "postalCode": "77235"
    },
    "parcel": {
      "weight": 10.5,
      "weightUnit": "g",
      "length": 10,
      "width": 10,
      "height": 10,
      "dimensionUnit": "cm",
      "items": [
        {
          "description": "Test item",
          "weight": 10.5,
          "value": 100,
          "weightUom": "g",
          "valueCurrencyCode": "usd"
        }
      ]
    },
    "customFieldMap": {}
  },
  "totalValue": 100,
  "sellerReferenceNumber": "<string>",
  "remarks": "<string>"
}
'
此页面由 AI 自动翻译。API 技术规格以英文呈现为标准。如有任何疑问,请参阅英文版本

授权

x-rr-apikey
string
header
必填

Your API key

x-rr-apitoken
string
header
必填

Your API token — keep this private

请求体

application/json
serviceTypeCode
string
默认值:fedex_ground
必填

Return service type code

orderTitle
string
默认值:Return Label Title
必填

Order title / return title

orderNumber
string
默认值:123123
必填

Order number

totalValueCurrency
string
默认值:usd
必填

Currency code for totalValue (e.g. USD)

shipment
object
必填

Shipment details including origin address and parcel info

totalValue
number
默认值:100

Total declared value of the return

sellerReferenceNumber
string

Seller reference number

remarks
string

Additional remarks

响应

Success