Whiplash Merchandising packages API

openapi: 3.1.0
info:
  version: '2.0'
  title: Rydership bundle_items packages API
  description: 'The Rydership V2 API is open by invite only. Fill out request form <a href="https://help.whiplash.com/hc/en-us/requests/new?ticket_form_id=360001303092"> here</a>.

    <br>

    <a href="api.v2.html">V2 documentation</a>

    <br>

    <a href="api.v2-1.html">V2.1 documentation</a>

    '
  contact:
    name: Rydership Development Team
    email: tech@whiplash.com
    url: https://www.getwhiplash.com
  x-logo:
    url: https://wl-s3-assets.s3.amazonaws.com/rydership/RyderShip-horizontal-safe-padding.svg
    backgroundColor: '#FFFFFF'
    altText: RyderShip
servers:
- url: ''
  description: Base Path
tags:
- name: packages
  description: Shipment package details and tracking.
paths:
  /api/v2/packages/{id}/shipping_documents:
    get:
      operationId: GetApiV2PackagesIdShippingDocuments
      tags:
      - packages
      summary: List shipping documents for a package
      description: List all shipping documents for a package
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: search
        in: query
        required: false
        schema:
          type: string
          description: 'JSON search string like {"attribute_eq": "Term"}'
      - name: fields
        in: query
        required: false
        schema:
          type: string
          description: Comma-separated list of fields to include in the response
      - name: sort
        in: query
        required: false
        schema:
          type: string
          description: 'A list of sort options (ex: name asc,created_at desc)'
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          description: Page of results to fetch
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          description: Number of results to return per page
      - name: page_total
        in: query
        required: false
        schema:
          type: boolean
          description: Include total count of results
      - name: page_links
        in: query
        required: false
        schema:
          type: boolean
          description: Include prev/next links in response headers
      responses:
        '200':
          description: List all shipping documents for a package
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV2EntitiesShippingDocument'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
components:
  schemas:
    ApiV2EntitiesShippingDocument:
      type: object
      title: V2
      properties:
        id:
          type: integer
          format: int32
          description: the shipping document id
        order_id:
          type: integer
          format: int32
          description: the associated order id
        owner_id:
          type: integer
          format: int32
          description: the owner id (Package or Order id)
        owner_type:
          type: string
          description: the owner type (Package or Order)
        provider_document_type:
          type:
          - string
          - 'null'
          description: type of document from provider (e.g. commercial_invoice, label)
        document_format:
          type: string
          description: document format (e.g. PDF, PNG)
        label_provider:
          type:
          - string
          - 'null'
          description: label provider name (e.g. easypost, shipium)
        electronically_submitted:
          type: boolean
          description: whether the document was electronically submitted to customs
        resolved_url:
          type: string
          description: the pre-signed or resolved document url
        created_at:
          type: string
          format: date-time
          description: the document creation date and time
        updated_at:
          type: string
          format: date-time
          description: the document last updated date and time
        url:
          type: string
          description: the internal document file url (S3 or CDN path) (staff only)
        provider_url:
          type:
          - string
          - 'null'
          description: the raw carrier-provided document url (staff only)
      additionalProperties: false
    ApiSharedEntitiesApiError:
      type: object
      title: Shared
      properties:
        message:
          type: string
          description: error message
      additionalProperties: false