GET /dropshipments/{id}.json

GET /dropshipments/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • adminNotes string | null

      Admin notes

    • aftershipId string | null

      Aftership

    • carrierPickupId integer(int32) | null

      Carrier pickup

    • channelAttempts integer(int32) | null Required

      Channel attempts

      Default value is 0.

    • channelError boolean | null

      Channel error

    • channelNotification string | null Required

      Channel notification

      Values are trigger or mute. Default value is trigger.

    • commercialInvoiceUrl string | null

      Commercial invoice url

    • createdAt string(date-time)

      Created at

    • days integer(int32) | null

      Days

    • distanceUnit string | null Required

      Distance unit

      Values are in or cm. Default value is in.

    • durationTerms string | null

      Duration terms

    • externalId string | null

      External

    • grams number | null Required

      Grams

      Default value is 0.

    • id integer(int32)

      Id

    • importSource string | null Required

      Import source

      Values are api, manual, platform, portal, or shippingEndpoint. Default value is manual.

    • intercomMessageId string | null

      Intercom message

    • inventoryStatus string Required

      Inventory status

      Values are notShipped or shipped. Default value is notShipped.

    • labelError string | null

      Label error

    • labelFileFormat string | null

      Label file format

      Values are png or pdf.

    • labelPrintStatus string | null Required

      Label print status

      Values are notPrinted, generating, or printed. Default value is notPrinted.

    • labelRefund boolean | null Required

      Label refund

      Default value is false.

    • labelUrl string | null

      Label url

    • manifestId integer(int32) | null

      Manifest

    • muteError boolean | null Required

      Mute error

      Default value is false.

    • packingDepth number | null Required

      Packing depth

      Default value is 2.4.

    • packingHeight number | null Required

      Packing height

      Default value is 13.3.

    • packingWidth number | null Required

      Packing width

      Default value is 11.5.

    • price number | null Required

      Price

      Default value is 0.

    • printedLabel boolean | null Required

      Printed label

      Default value is false.

    • printedLabelAt string(date-time) | null

      Printed label at

    • provider string | null

      Provider

    • purchaseId integer(int32) Required

      Purchase

    • purchaseImportExternalId string | null

      Purchase import external

    • quoteId string | null

      Quote

    • reference string Required

      Reference

    • requiresShippingApproval string | null Required

      Requires shipping approval

      Values are notRequired, approvalRequired, rateRequired, or approved. Default value is notRequired.

    • saleId integer(int32) | null

      Sale

    • sendShippingUpdateProblem object | null | array | boolean | integer | number | string

      Send shipping update problem

    • serviceLevel string | null

      Service level

    • serviceLevelTerms string | null

      Service level terms

    • shipmentRouting string | null Required

      Shipment routing

      Values are customer, consolidated, or consolidatedInternational. Default value is customer.

    • shippoLabelIds array[string] | null

      Shippo label ids

    • source string | null Required

      Source

      Values are sale or dropship_purchase_import. Default value is sale.

    • tags array[string] | null

      Tags

    • totalWeight number(float) | null Required

      Total weight

      Default value is 0.

    • trackingCompany string | null

      Tracking company

    • trackingNumber string | null

      Tracking number

    • trackingStatus string | null

      Tracking status

      Values are delivered, failure, pre_transit, returned, transit, or unknown.

    • 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

    • userId integer(int32) | null

      User

    • vendorExternalId string | null

      Vendor external

    • weightUnit string | null Required

      Weight unit

      Values are g, kg, oz, or lb. Default value is g.

GET /dropshipments/{id}.json
curl \
 --request GET 'http://api.example.com/v1/dropshipments/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "adminNotes": "string",
  "aftershipId": "string",
  "carrierPickupId": 42,
  "channelAttempts": 0,
  "channelError": true,
  "channelNotification": "trigger",
  "commercialInvoiceUrl": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "days": 42,
  "distanceUnit": "in",
  "durationTerms": "string",
  "externalId": "string",
  "files": {},
  "grams": 0,
  "id": 42,
  "importSource": "manual",
  "intercomMessageId": "string",
  "inventoryStatus": "notShipped",
  "labelError": "string",
  "labelFileFormat": "png",
  "labelFiles": {},
  "labelPrintStatus": "notPrinted",
  "labelProblem": {},
  "labelRefund": false,
  "labelUris": {},
  "labelUrl": "string",
  "manifestId": 42,
  "muteError": false,
  "packingDepth": 2.4,
  "packingHeight": 13.3,
  "packingWidth": 11.5,
  "pickupProblem": {},
  "price": 0,
  "printedLabel": false,
  "printedLabelAt": "2025-05-04T09:42:00Z",
  "provider": "string",
  "purchaseId": 42,
  "purchaseImportExternalId": "string",
  "quoteId": "string",
  "reference": "string",
  "requiresShippingApproval": "notRequired",
  "saleId": 42,
  "sendShippingUpdateProblem": {},
  "serviceLevel": "string",
  "serviceLevelTerms": "string",
  "shipmentRouting": "customer",
  "shippoLabelIds": [
    "string"
  ],
  "source": "sale",
  "tags": [
    "string"
  ],
  "totalWeight": 0,
  "trackingCompany": "string",
  "trackingNumber": "string",
  "trackingStatus": "delivered",
  "trackingStatusDate": "2025-05-04T09:42:00Z",
  "trackingStatusDetails": "string",
  "trackingUrl": "string",
  "updatedAt": "2025-05-04T09:42:00Z",
  "userId": 42,
  "vendorExternalId": "string",
  "weightUnit": "g"
}