Retrieve shipping policy by ID
Retrieves information from a shipping policy from your store, searching by shipping policy ID.
⚠️ While most endpoints return time fields in UTC format, this endpoint returns Scheduled Delivery related time fields adjusted to the time zone configured for the VTEX account.
Permissions
Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:
| Product | Category | Resource |
|---|---|---|
| Logistics | Logistics access | Logistics full access |
| Logistics | Logistics access | Logistics viewer |
| Logistics | Logistics access | Logistics shipping full access |
You can create a custom role with that resource or use one of the following predefined roles:
| Role | Resource |
|---|---|
| Logistics - Full access | Logistics full access |
| OMS - Full access | Logistics full access |
| Logistics - Full access | Logistics viewer |
| Logistics - Read only | Logistics viewer |
| Logistics - Full access | Logistics shipping full access |
| OMS - Full access | Logistics shipping full access |
❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys. To learn more about machine authentication at VTEX, see Authentication overview.
Path parameters
Shipping policy ID.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Response
OK