PUT /purchases/{id}/default-label.json

PUT /purchases/{id}/default-label.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

application/json

Body Required

Responses

PUT /purchases/{id}/default-label.json
curl \
 -X PUT http://api.example.com/v1/purchases/{id}/default-label.json \
 -H "Content-Type: application/json" \
 -d '{"adminNotes":"string","aftershipId":"string","carrierPickupId":42,"channelAttempts":0,"channelError":true,"channelNotification":"trigger","commercialInvoiceUrl":"string","createdAt":"2023-05-04T09:42:00+00:00","days":42,"distanceUnit":"in","durationTerms":"string","externalId":"string","files":{},"grams":0,"id":42,"importSource":"manual","intercomMessageId":"string","inventoryStatus":"notShipped","labelError":"string","labelFileFormat":"png","labelFiles":{},"labelProblem":{},"labelRefund":false,"labelUris":{},"labelUrl":"string","manifestId":42,"muteError":false,"packingDepth":2.4,"packingHeight":13.3,"packingWidth":11.5,"price":0,"printedLabel":false,"printedLabelAt":"2023-05-04T09:42:00+00:00","provider":"string","purchaseId":42,"purchaseImportExternalId":"string","quoteId":"string","reference":"string","requiresShippingApproval":"notRequired","saleId":42,"serviceLevel":"string","serviceLevelTerms":"string","shipmentRouting":"customer","shippoLabelIds":["string"],"source":"sale","tags":["string"],"totalWeight":0,"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","userId":42,"vendorExternalId":"string","weightUnit":"g"}'
Request example
{
  "adminNotes": "string",
  "aftershipId": "string",
  "carrierPickupId": 42,
  "channelAttempts": 0,
  "channelError": true,
  "channelNotification": "trigger",
  "commercialInvoiceUrl": "string",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "days": 42,
  "distanceUnit": "in",
  "durationTerms": "string",
  "externalId": "string",
  "files": {},
  "grams": 0,
  "id": 42,
  "importSource": "manual",
  "intercomMessageId": "string",
  "inventoryStatus": "notShipped",
  "labelError": "string",
  "labelFileFormat": "png",
  "labelFiles": {},
  "labelProblem": {},
  "labelRefund": false,
  "labelUris": {},
  "labelUrl": "string",
  "manifestId": 42,
  "muteError": false,
  "packingDepth": 2.4,
  "packingHeight": 13.3,
  "packingWidth": 11.5,
  "price": 0,
  "printedLabel": false,
  "printedLabelAt": "2023-05-04T09:42:00+00:00",
  "provider": "string",
  "purchaseId": 42,
  "purchaseImportExternalId": "string",
  "quoteId": "string",
  "reference": "string",
  "requiresShippingApproval": "notRequired",
  "saleId": 42,
  "serviceLevel": "string",
  "serviceLevelTerms": "string",
  "shipmentRouting": "customer",
  "shippoLabelIds": [
    "string"
  ],
  "source": "sale",
  "tags": [
    "string"
  ],
  "totalWeight": 0,
  "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",
  "userId": 42,
  "vendorExternalId": "string",
  "weightUnit": "g"
}
Response examples (200)
{
  "adminNotes": "string",
  "aftershipId": "string",
  "carrierPickupId": 42,
  "channelAttempts": 0,
  "channelError": true,
  "channelNotification": "trigger",
  "commercialInvoiceUrl": "string",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "days": 42,
  "distanceUnit": "in",
  "durationTerms": "string",
  "externalId": "string",
  "files": {},
  "grams": 0,
  "id": 42,
  "importSource": "manual",
  "intercomMessageId": "string",
  "inventoryStatus": "notShipped",
  "labelError": "string",
  "labelFileFormat": "png",
  "labelFiles": {},
  "labelProblem": {},
  "labelRefund": false,
  "labelUris": {},
  "labelUrl": "string",
  "manifestId": 42,
  "muteError": false,
  "packingDepth": 2.4,
  "packingHeight": 13.3,
  "packingWidth": 11.5,
  "price": 0,
  "printedLabel": false,
  "printedLabelAt": "2023-05-04T09:42:00+00:00",
  "provider": "string",
  "purchaseId": 42,
  "purchaseImportExternalId": "string",
  "quoteId": "string",
  "reference": "string",
  "requiresShippingApproval": "notRequired",
  "saleId": 42,
  "serviceLevel": "string",
  "serviceLevelTerms": "string",
  "shipmentRouting": "customer",
  "shippoLabelIds": [
    "string"
  ],
  "source": "sale",
  "tags": [
    "string"
  ],
  "totalWeight": 0,
  "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",
  "userId": 42,
  "vendorExternalId": "string",
  "weightUnit": "g"
}