POST /return-shipments.json

POST /return-shipments.json
application/json

Body Required

Responses

POST /return-shipments.json
curl \
 -X POST http://api.example.com/v1/return-shipments.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"aftershipId":"string","commercialInvoiceUrl":"string","days":42,"dropshipmentId":42,"durationTerms":"string","fulfillmentId":42,"grams":0,"labelError":"string","labelFileFormat":"png","labelFiles":{},"labelRefund":false,"labelUris":{},"labelUrl":"string","price":0,"provider":"string","purchaseId":42,"quoteId":"string","serviceLevel":"string","serviceLevelTerms":"string","shippoLabelIds":["string"],"tags":["string"],"trackingCompany":"string","trackingNumber":"string","trackingStatus":"delivered","trackingStatusDate":"2024-05-04T09:42:00+00:00","trackingStatusDetails":"string","trackingUrl":"string"}'
Request example
{
  "aftershipId": "string",
  "commercialInvoiceUrl": "string",
  "days": 42,
  "dropshipmentId": 42,
  "durationTerms": "string",
  "fulfillmentId": 42,
  "grams": 0,
  "labelError": "string",
  "labelFileFormat": "png",
  "labelFiles": {},
  "labelRefund": false,
  "labelUris": {},
  "labelUrl": "string",
  "price": 0,
  "provider": "string",
  "purchaseId": 42,
  "quoteId": "string",
  "serviceLevel": "string",
  "serviceLevelTerms": "string",
  "shippoLabelIds": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "trackingCompany": "string",
  "trackingNumber": "string",
  "trackingStatus": "delivered",
  "trackingStatusDate": "2024-05-04T09:42:00+00:00",
  "trackingStatusDetails": "string",
  "trackingUrl": "string"
}
Response examples (200)
{
  "aftershipId": "string",
  "commercialInvoiceUrl": "string",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "days": 42,
  "dropshipmentId": 42,
  "durationTerms": "string",
  "fulfillmentId": 42,
  "grams": 0,
  "id": 42,
  "labelError": "string",
  "labelFileFormat": "png",
  "labelFiles": {},
  "labelRefund": false,
  "labelUris": {},
  "labelUrl": "string",
  "price": 0,
  "provider": "string",
  "purchaseId": 42,
  "quoteId": "string",
  "serviceLevel": "string",
  "serviceLevelTerms": "string",
  "shippoLabelIds": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "trackingCompany": "string",
  "trackingNumber": "string",
  "trackingStatus": "delivered",
  "trackingStatusDate": "2024-05-04T09:42:00+00:00",
  "trackingStatusDetails": "string",
  "trackingUrl": "string",
  "updatedAt": "2024-05-04T09:42:00+00:00"
}