zonos-openapi.yml

zonos-openapi.yml

openapi: 3.1.0
info:
  title: Zonos
  version: 0.1.0
servers:
  - url: https://api.zonos.com/v1
    description: main
paths:
  /landed_cost:
    post:
      parameters:
        - in: header
          required: true
          name: zonos-version
          examples: [2019-11-21]
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                currency:
                  required: true
                  type: string
                  discounts:
                    type: array
                    values:
                      type: object
                      properties:
                        id:
                          type: string
                        amount:
                          type: number
                        detail:
                          additionalProperties:
                            type: string
                  items:
                    type: array
                    values:
                      id:
                        type: string
                        required: true
                      amount:
                        type: number
                      amount_discount:
                        type: number
                      brand:
                        type: string
                      category:
                        type: string
                      color:
                        type: string
                      country_of_origin:
                        type: string
                      description_customs:
                        type: string
                      description_retail:
                        type: string
                      detail:
                        additionalProperties:
                          type: string
                      dimensions:
                        type: object
                        properties:
                          height:
                            type: number
                          length:
                            type: number
                          unit:
                            type: string
                          width:
                            type: number
                      duty_tax_fee_free:
                        type: string
                      hs_code:
                        type: string
                      image_url:
                        type: string
                      quantity:
                        required: true
                        type: integer
                      upc_code:
                        type: string
                      weight:
                        type: number
                      weight_unit:
                        type: string
                      landed_cost:
                        type: string
                        nullable: true
                        enum:
                          - delivery_duty_paid
                          - delivery_duty_unpaid
                      sale_type:
                        type: string
                        nullable: true
                        enum:
                          - not_for_resale
                          - for_resale
                      ship_from_country:
                        required: true
                        type: string
                      ship_to:
                        required: true
                        type: object
                        properties:
                          city:
                            type: string
                          state:
                            type: string
                          country:
                            required: true
                            type: string
                          postal_code:
                            type: string
                      shipping:
                        required: true
                        type: object
                        properties:
                          amount:
                            required: true
                            type: number
                          amount_discount:
                            type: number
                          service_level:
                            required: true
                            type: string