> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Rate-shop a vendor RTV shipping label (estimate, no buy)

> Live rate-shop for a vendor return-to-vendor (RTV) shipping label using the entity's configured
Shippo carrier accounts. Returns the available rates[] WITHOUT purchasing a label (estimate only).
Ship-from is the default warehouse; ship-to is the vendor's configured RMA return address (422
vendor_rma_address_not_configured when the vendor has no RMA or default address). Mirrors the
customer return-label rate-shop contract.

**Authorization:** compound read scope, requires BOTH returns:read AND fulfillment:read.




## OpenAPI

````yaml /openapi.yaml get /vendor-returns/{id}/return-label/rates
openapi: 3.1.0
info:
  title: Arcus ERP Public API
  version: 1.0.0
  description: >
    Arcus ERP public REST API. Designed for external integrations and data
    migration.


    **Authentication.** Bearer token (API key) via the `Authorization` header.

    Format: `Authorization: Bearer ark_live_ent_<code>_<random>` (or
    `ark_test_*` for sandbox).

    API keys are issued per-entity in **Settings > Developers > API Keys**.


    **Entity scoping.** The entity is encoded in the API key prefix; routes are
    flat

    (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform
    endpoints

    (migration, reconciliation, events, webhook endpoints, API keys) use the

    `/v1/entities/{entity_id}/...` form -- those are noted in their tags.


    **Key capabilities.**
      - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource).
      - Cursor-based pagination (`starting_after` / `ending_before` / `limit`).
      - Idempotency via the `Idempotency-Key` header.
      - Webhook events for asynchronous notification.
      - Conditional requests / ETag for cache validation.
servers:
  - url: https://api.arcuserp.com/v1
    description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys)
  - url: https://dev-api.arcuserp.com/v1
    description: >-
      Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev
      RDS)
security: []
paths:
  /vendor-returns/{id}/return-label/rates:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Returns
      summary: Rate-shop a vendor RTV shipping label (estimate, no buy)
      description: >
        Live rate-shop for a vendor return-to-vendor (RTV) shipping label using
        the entity's configured

        Shippo carrier accounts. Returns the available rates[] WITHOUT
        purchasing a label (estimate only).

        Ship-from is the default warehouse; ship-to is the vendor's configured
        RMA return address (422

        vendor_rma_address_not_configured when the vendor has no RMA or default
        address). Mirrors the

        customer return-label rate-shop contract.


        **Authorization:** compound read scope, requires BOTH returns:read AND
        fulfillment:read.
      operationId: getVendorReturnLabelRatesV1
      parameters:
        - name: package_length_in
          in: query
          required: false
          schema:
            type: number
          description: Parcel length in inches (default 12).
        - name: package_width_in
          in: query
          required: false
          schema:
            type: number
          description: Parcel width in inches (default 10).
        - name: package_height_in
          in: query
          required: false
          schema:
            type: number
          description: Parcel height in inches (default 6).
        - name: package_weight_lbs
          in: query
          required: false
          schema:
            type: number
          description: Parcel weight in pounds (default 2).
      responses:
        '200':
          description: Available vendor RTV label rates (estimate)
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      rates:
                        type: array
                        items:
                          type: object
                      ship_from:
                        type: object
                      ship_to:
                        type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
      security:
        - ApiKeyAuth: []
components:
  responses:
    Error:
      description: Error response (400/401/403/404/409/422/429/500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    ErrorEnvelope:
      type: object
      description: |
        Canonical error response envelope. All API errors use this shape.
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: Machine-readable error key
          example: not_found
        code:
          type: string
          description: Machine-readable error code (often same as error)
          example: not_found
        type:
          type: string
          enum:
            - validation_error
            - permission_error
            - not_found
            - conflict
            - rate_limit
            - internal
            - expand_error
            - not_implemented
          example: not_found
        hint:
          type: string
          description: Human-readable one-sentence explanation (English)
          example: >-
            The requested order does not exist or does not belong to this
            entity.
        param:
          type: string
          description: The parameter that caused the error, if applicable
          example: expand[0]
        required:
          type: string
          description: The scope required (only on insufficient_scope errors)
          example: accounts:read
        request_id:
          type: string
          description: >-
            Unique request ID for support tracing (maps to CloudWatch log
            stream)
          example: req_abc123
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key issued per entity via Settings > Developers > API Keys.
        Each key carries scopes (e.g. orders:read, products:write).
        Bearer token format: Authorization: Bearer ark_live_ent_<code>_<random>
        Test keys use ark_test_ent_<code>_<random>. Both are issued per entity
        via Settings > Developers > API Keys.

````