POST /purchases/{id}/return-label.json
POST
/purchases/{id}/return-label.json
Path parameters
-
id integer(int64) Required
Numeric ID of the instance
Minimum value is
1.
Body Required
-
aftershipId string | null
Aftership
-
commercialInvoiceUrl string | null
Commercial invoice url
-
createdAt string(date-time)
Created at
-
days integer(int32) | null
Days
-
dropshipmentId integer(int32) | null
Dropshipment
-
durationTerms string | null
Duration terms
-
fulfillmentId integer(int32) | null
Fulfillment
-
grams number | null Required
Grams
Default value is
0. -
id integer(int32)
Id
-
labelError string | null
Label error
-
labelFileFormat string | null
Label file format
Values are
pngorpdf. - labelFiles object | null | array | boolean | integer | number | string
-
labelRefund boolean | null Required
Label refund
Default value is
false. -
labelUrl string | null
Label url
-
price number | null Required
Price
Default value is
0. -
provider string | null
Provider
-
purchaseId integer(int32) | null
Purchase
-
quoteId string | null
Quote
-
serviceLevel string | null
Service level
-
serviceLevelTerms string | null
Service level terms
-
shippoLabelIds array[string] | null
Shippo label ids
-
trackingCompany string | null
Tracking company
-
trackingNumber string | null
Tracking number
-
trackingStatus string | null
Tracking status
Values are
delivered,failure,pre_transit,returned,transit, orunknown. -
trackingStatusDate string(date-time) | null
Tracking status date
-
trackingStatusDetails string | null
Tracking status details
-
trackingUrl string | null
Tracking url
-
updatedAt string(date-time)
Updated at
POST /purchases/{id}/return-label.json
curl \
-X POST http://api.example.com/v1/purchases/{id}/return-label.json \
-H "Content-Type: application/json" \
-d '{"aftershipId":"string","commercialInvoiceUrl":"string","createdAt":"2023-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":"2023-05-04T09:42:00+00:00","trackingStatusDetails":"string","trackingUrl":"string","updatedAt":"2023-05-04T09:42:00+00:00"}'
Request example
{
"aftershipId": "string",
"commercialInvoiceUrl": "string",
"createdAt": "2023-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": "2023-05-04T09:42:00+00:00",
"trackingStatusDetails": "string",
"trackingUrl": "string",
"updatedAt": "2023-05-04T09:42:00+00:00"
}
Response example (200)
{
"aftershipId": "string",
"commercialInvoiceUrl": "string",
"createdAt": "2023-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": "2023-05-04T09:42:00+00:00",
"trackingStatusDetails": "string",
"trackingUrl": "string",
"updatedAt": "2023-05-04T09:42:00+00:00"
}