GET /purchase-shipping-rates/{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
- createdAt string(date-time) | null
  
  Created at
- days integer(int32) | null
  
  Days
- dropshipmentId integer(int32) | null
  
  Dropshipment
- durationTerms string | null
  
  Duration terms
- fullPrice number | null
  
  Full price
- id integer(int32)
  
  Id
- invoiceEligibility string | null Required
  
  Invoice eligibility
  
  Values are eligible or freeShipping. Default value is eligible.
- invoiceShipping boolean | null Required
  
  Invoice shipping
  
  Default value is false.
- invoiceShippingType string | null
  
  Invoice shipping type
  
  Values are addition, deduct, or commission.
- price number Required
  
  Price
- provider string | null
  
  Provider
- purchaseId integer(int32) Required
  
  Purchase
- purchaseInvoiceId integer(int32) | null
  
  Purchase invoice
- ratePurpose string | null Required
  
  Rate purpose
  
  Values are none, label, or invoice. Default value is label.
- serviceCode string | null
  
  Service code
- serviceLevel string | null
  
  Service level
- serviceLevelTerms string | null
  
  Service level terms
- serviceLevelToken string | null
  
  Service level token
- shippingCommission number | null Required
  
  Shipping commission
  
  Default value is 0.
- shippingRateId integer(int32) | null
  
  Shipping rate
- targetPrice number | null
  
  Target price
- tax number | null
  
  Tax
- updatedAt string(date-time) | null
  
  Updated at

curl \
 --request GET 'http://api.example.com/v1/purchase-shipping-rates/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "days": 42,
  "dropshipmentId": 42,
  "durationTerms": "string",
  "fullPrice": 42.0,
  "id": 42,
  "invoiceEligibility": "eligible",
  "invoiceShipping": false,
  "invoiceShippingType": "addition",
  "price": 42.0,
  "provider": "string",
  "purchaseId": 42,
  "purchaseInvoiceId": 42,
  "ratePurpose": "label",
  "serviceCode": "string",
  "serviceLevel": "string",
  "serviceLevelTerms": "string",
  "serviceLevelToken": "string",
  "shippingCommission": 0,
  "shippingRateId": 42,
  "targetPrice": 42.0,
  "tax": 42.0,
  "updatedAt": "2025-05-04T09:42:00Z"
}