openapi: 3.0.3
info:
  title: Tiendanube / Nuvemshop Categories Shipping Carriers API
  description: Representative OpenAPI description of the Tiendanube (Nuvemshop) REST API for app partners. All requests are scoped to a single store via the {store_id} path segment, authenticated with an OAuth 2.0 access token sent in the Authentication header, and MUST include a descriptive User-Agent header identifying the app. The Brazil deployment mirrors this API at https://api.nuvemshop.com.br/v1/{store_id}.
  termsOfService: https://www.tiendanube.com/terminos-de-uso
  contact:
    name: Tiendanube Developers
    url: https://tiendanube.github.io/api-documentation/
  version: '1.0'
servers:
- url: https://api.tiendanube.com/v1/{store_id}
  description: Tiendanube (Spanish-speaking Latin America)
  variables:
    store_id:
      default: '0'
      description: Numeric ID of the store the app is operating on.
- url: https://api.nuvemshop.com.br/v1/{store_id}
  description: Nuvemshop (Brazil)
  variables:
    store_id:
      default: '0'
      description: Numeric ID of the store the app is operating on.
security:
- AuthenticationToken: []
tags:
- name: Shipping Carriers
paths:
  /shipping_carriers:
    get:
      operationId: listShippingCarriers
      tags:
      - Shipping Carriers
      summary: List shipping carriers
      responses:
        '200':
          description: A list of shipping carriers.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ShippingCarrier'
    post:
      operationId: createShippingCarrier
      tags:
      - Shipping Carriers
      summary: Register a shipping carrier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippingCarrier'
      responses:
        '201':
          description: Shipping carrier registered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingCarrier'
components:
  schemas:
    ShippingCarrier:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        callback_url:
          type: string
          format: uri
        types:
          type: string
          example: ship,pickup
        active:
          type: boolean
        options:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              name:
                type: string
              additional_days:
                type: integer
  securitySchemes:
    AuthenticationToken:
      type: apiKey
      in: header
      name: Authentication
      description: 'OAuth 2.0 access token obtained via the authorization-code flow, sent as "Authentication: bearer {access_token}". A descriptive User-Agent header is also required on every request.'