openapi: 3.0.3
info:
  title: SaaSPatform
  description: ''
  version: 1.0.0
servers:
  -
    url: 'http://localhost'
paths:
  /api/v1/hermes/parcels-groups:
    post:
      summary: ''
      operationId: postApiV1HermesParcelsGroups
      description: ''
      parameters: []
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  code: Unauthorized
                properties:
                  code:
                    type: string
                    example: Unauthorized
      tags:
        - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                CreateParcelsGroup:
                  type: object
                  description: ''
                  example: []
                  properties:
                    Apikey:
                      type: string
                      description: ''
                      example: ut
                    ParcelsGroup:
                      type: object
                      description: ''
                      example: []
                      properties:
                        MawbDate:
                          type: string
                          description: 'Must be a valid date.'
                          example: '2024-06-19T04:40:04'
                        ArrivalDate:
                          type: string
                          description: 'Must be a valid date.'
                          example: '2024-06-19T04:40:04'
              required:
                - CreateParcelsGroup
      security: []
    delete:
      summary: ''
      operationId: deleteApiV1HermesParcelsGroups
      description: ''
      parameters: []
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  code: Unauthorized
                properties:
                  code:
                    type: string
                    example: Unauthorized
      tags:
        - Endpoints
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                CancelParcelsGroup:
                  type: object
                  description: ''
                  example: []
                  properties:
                    Apikey:
                      type: string
                      description: ''
                      example: exercitationem
      security: []
  /api/v1/hermes/parcels:
    post:
      summary: ''
      operationId: postApiV1HermesParcels
      description: ''
      parameters: []
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  code: Unauthorized
                properties:
                  code:
                    type: string
                    example: Unauthorized
      tags:
        - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                CreateParcel:
                  type: object
                  description: ''
                  example: []
                  properties:
                    Apikey:
                      type: string
                      description: 'API key'
                      example: quisquam
                    IsTest:
                      type: boolean
                      description: 'Test mode flag. true - test mode'
                      example: true
                    Parcel:
                      type: object
                      description: 'The Parcel details'
                      example: []
                      properties:
                        Source:
                          type: string
                          description: 'Use “HERMES_CORP”.'
                          example: HERMES_CORP
                        ReasonForExport:
                          type: string
                          description: 'Reason for export'
                          example: omnis
                        TrackingNumber:
                          type: string
                          description: 'Hermes Assigned Tracking Number'
                          example: itaque
                        Manifest:
                          type: boolean
                          description: ''
                          example: false
                        LabelType:
                          type: string
                          description: ''
                          example: earum
                        LabelFormat:
                          type: string
                          description: 'in:PNG,PDF,ZPL200,ZPL300'
                          example: et
                        FulfilmentOrigin:
                          type: string
                          description: ''
                          example: sed
                        ShipperReferenceID:
                          type: string
                          description: ''
                          example: nobis
                        CustomerReference1:
                          type: string
                          description: ''
                          example: fugiat
                        CustomerReference2:
                          type: string
                          description: ''
                          example: minima
                        Shipper:
                          type: object
                          description: 'The Shipper details'
                          example: []
                          properties:
                            AccountNumber:
                              type: string
                              description: 'Hermes Account Number, will be used to send back billing data'
                              example: quos
                            ContactName:
                              type: string
                              description: ''
                              example: alias
                            Company:
                              type: string
                              description: ''
                              example: hic
                            Address1:
                              type: string
                              description: ''
                              example: non
                            Address2:
                              type: string
                              description: ''
                              example: qui
                            Address3:
                              type: string
                              description: ''
                              example: iste
                            City:
                              type: string
                              description: ''
                              example: fuga
                            Country:
                              type: string
                              description: ''
                              example: necessitatibus
                            Zip:
                              type: string
                              description: 'Required for Countries/Territories that use Zip/Postal codes'
                              example: doloribus
                            CountryCode:
                              type: string
                              description: 'ISO Country/Territory Code Eg. “GB”.'
                              example: autem
                            Phone:
                              type: string
                              description: ''
                              example: beatae
                            Email:
                              type: email
                              description: ''
                              example: maud.barrows@example.com
                            Vat:
                              type: string
                              description: ''
                              example: libero
                            TaxID:
                              type: string
                              description: 'Norway VOEC / Import EORI number'
                              example: placeat
                            Eori:
                              type: string
                              description: 'Shipper UK EORI Number'
                              example: officiis
                            RegNumber:
                              type: string
                              description: 'Shipper OSS/IOSS Registration Number Required for IOSS shipments to destination EU'
                              example: animi
                            Url:
                              type: string
                              description: 'Required for USA destination'
                              example: 'https://www.johnston.org/ex-repellat-tempore-vero-vitae-aut-dolorem'
                        Consignee:
                          type: object
                          description: 'The Consignee details'
                          example: []
                          properties:
                            ContactName:
                              type: string
                              description: ''
                              example: itaque
                            Company:
                              type: string
                              description: ''
                              example: asperiores
                            Address1:
                              type: string
                              description: ''
                              example: alias
                            Address2:
                              type: string
                              description: ''
                              example: quia
                            Address3:
                              type: string
                              description: ''
                              example: quis
                            City:
                              type: string
                              description: ''
                              example: quod
                            Country:
                              type: string
                              description: 'Required for USA and Canada destinations (Use 2 letter State Codes). Required for Australia destination (Use 2 / 3 letter state code).'
                              example: earum
                            Zip:
                              type: string
                              description: 'Required for Destination Countries/Territories that use Zip/Post codes.'
                              example: qui
                            CountryCode:
                              type: string
                              description: 'ISO Country/Territory Code.'
                              example: voluptas
                            Phone:
                              type: string
                              description: 'Required for PUDO services and shipments going to HU, CZ, PL, SK and HR. (must be mobile), otherwise recommended. International format only (eg. +441268123456).'
                              example: quo
                            Email:
                              type: email
                              description: ''
                              example: amy74@example.com
                            Vat:
                              type: string
                              description: ''
                              example: nemo
                            PudoID:
                              type: string
                              description: 'Required for PUDO services. Pickup ID of the pickup point.'
                              example: nostrum
                            NationalID:
                              type: string
                              description: ''
                              example: quia
                            PassportNumber:
                              type: string
                              description: 'Required depending on destination/route'
                              example: eaque
                            PassportIssueDate:
                              type: 'date_format:d/m/Y'
                              description: 'Required depending on destination/route, DD/MM/YYYY format'
                              example: corrupti
                            PassportExpiryDate:
                              type: 'date_format:d/m/Y'
                              description: 'Required depending on destination/route, DD/MM/YYYY format'
                              example: repellat
                            PassportIssuedBy:
                              type: string
                              description: 'Required depending on destination/route'
                              example: iusto
                            PassportIssueCountryCode:
                              type: string
                              description: 'Required depending on destination/route.'
                              example: GB
                            ContactNameLocal:
                              type: string
                              description: 'Required depending on destination/route'
                              example: aliquam
                            TaxID:
                              type: string
                              description: 'Required depending on destination/route'
                              example: illo
                        PaymentReferenceNumber:
                          type: string
                          description: 'Required depending on destination/route'
                          example: id
                        PaymentDateTime:
                          type: string
                          description: 'Required depending on destination/route Format: YYYY-MM-DD HH:MM:SS'
                          example: tenetur
                        PaymentProvider:
                          type: string
                          description: 'Required depending on destination/route'
                          example: voluptatum
                        Service:
                          type: string
                          description: 'Use ‘HERMES_INTERNATIONAL’.'
                          example: HERMES_INTERNATIONAL
                        Collect:
                          type: string
                          description: ''
                          example: molestiae
                        Pieces:
                          type: string
                          description: 'Always “1”.'
                          example: '1'
                        Weight:
                          type: string
                          description: 'Eg. “3.02”.'
                          example: '3.02'
                        WeightUnit:
                          type: string
                          description: '“K” = Kg, “L” = Lbs.'
                          example: K
                        Length:
                          type: numeric
                          description: 'In Cms.'
                          example: '4'
                        Width:
                          type: numeric
                          description: 'In Cms.'
                          example: '4'
                        Height:
                          type: numeric
                          description: 'In Cms.'
                          example: '4'
                        DimUnit:
                          type: string
                          description: '“cm” only.'
                          example: cm
                        DescriptionOfGoods:
                          type: string
                          description: 'Overall Shipment Description'
                          example: quam
                        Value:
                          type: numeric
                          description: 'Overall Shipment Value'
                          example: iste
                        ShippingCost:
                          type: numeric
                          description: 'Overall Cost of Shipping'
                          example: voluptatem
                        Currency:
                          type: string
                          description: 'ISO Currency Code.'
                          example: GBP
                        MerchantARN:
                          type: string
                          description: 'Merchant ARN required for GST calculation (Australia)'
                          example: nulla
                        PurchaserABN:
                          type: string
                          description: 'Purchaser ABN If applicable (Australia)'
                          example: incidunt
                        GSTExemptionCode:
                          type: string
                          description: 'If GST has not been charged, then provide the exemption code (Australia)'
                          example: officiis
                        Terms:
                          type: string
                          description: '“DDU” or “DDP”.'
                          example: DDP
                        CODAmount:
                          type: numeric
                          description: 'Cash on Delivery Amount.'
                          example: '132.99'
                        CODCurrency:
                          type: string
                          description: 'Cash on Delivery Currency. 3 Characters. Example GBP'
                          example: sed
                        DangerousGoods:
                          type: boolean
                          description: ''
                          example: false
                        ShipperBrandingID:
                          type: string
                          description: ''
                          example: debitis
                        Items:
                          type: array
                          description: ''
                          example:
                            - []
                          items:
                            type: object
                            properties:
                              Description:
                                type: string
                                description: 'Required for outside EU'
                                example: 'Dolorem repellat omnis aliquam dolores.'
                              SkuCode:
                                type: string
                                description: 'For China and Russia, please populate with SKU Code'
                                example: est
                              HsCode:
                                type: string
                                description: 'For China Direct, please populate with HS Code'
                                example: beatae
                              CountryOfOrigin:
                                type: string
                                description: 'ISO Country/Territory Code'
                                example: esse
                              PurchaseUrl:
                                type: string
                                description: 'Direct link to the product required for Russia'
                                example: 'http://www.pacocha.com/error-porro-officia-perspiciatis-assumenda'
                              ImageUrl:
                                type: string
                                description: 'Direct link to the product image'
                                example: 'http://www.hills.org/'
                              Quantity:
                                type: numeric
                                description: 'Total number of pieces in this item Required for outside EU'
                                example: ut
                              Value:
                                type: numeric
                                description: 'Total value of this item (all pieces). Required for outside EU'
                                example: dolore
                              DetailedDescription:
                                type: string
                                description: 'Detailed description of the item'
                                example: cumque
                              ItemComposition:
                                type: string
                                description: 'Composition of the item.'
                                example: '100% Cotton'
                              DG:
                                type: object
                                description: 'Dangerous goods info (if present parcel''s DangerousGoods should be true)'
                                example: []
                                properties:
                                  Type:
                                    type: string
                                    description: 'Dangerous goods type. 2 Characters. Example LQ'
                                    example: vero
                                  ProductType:
                                    type: string
                                    description: 'Dangerous goods product type. Example UN1266'
                                    example: quasi
                                  Capacity:
                                    type: numeric
                                    description: 'Capacity. 6 digits, 3 decimal points. Example 1.000'
                                    example: beatae
                                  CapacityUOM:
                                    type: string
                                    description: 'CapacityUOM. “l“ = Litres, “ml“ = Millilitres, “g“ = Grams. Example g'
                                    example: reiciendis
              required:
                - CreateParcel
      security: []
    delete:
      summary: 'Hermes Cancel Parcels.'
      operationId: hermesCancelParcels
      description: "Store a newly created resource in storage.\nTODO: Move to ApiHermesCancelParcelAction"
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  tracking_number: Error
                  another_tracking_number: Canceled
                  third_tracking_number: 'Error message'
                properties:
                  tracking_number:
                    type: string
                    example: Error
                  another_tracking_number:
                    type: string
                    example: Canceled
                  third_tracking_number:
                    type: string
                    example: 'Error message'
      tags:
        - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tracking_numbers:
                  type: object
                  description: ''
                  example: []
                  properties: {  }
                api_key:
                  type: string
                  description: ''
                  example: ipsam
                CancelParcel:
                  type: object
                  description: ''
                  example: []
                  properties:
                    Apikey:
                      type: string
                      description: 'API key'
                      example: id
                    Parcel:
                      type: object
                      description: 'The Parcel details'
                      example: []
                      properties:
                        TrackingNumber:
                          type: array
                          description: 'Hermes Assigned Tracking Numbers'
                          example:
                            - eos
                          items:
                            type: string
              required:
                - tracking_numbers
                - api_key
                - CancelParcel
      security: []
  /api/v1/hermes/parcels/register:
    post:
      summary: ''
      operationId: postApiV1HermesParcelsRegister
      description: ''
      parameters: []
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  code: Unauthorized
                properties:
                  code:
                    type: string
                    example: Unauthorized
      tags:
        - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                CreateParcel:
                  type: object
                  description: ''
                  example: []
                  properties:
                    Apikey:
                      type: string
                      description: 'API key'
                      example: nostrum
                    IsTest:
                      type: boolean
                      description: 'Test mode flag. true - test mode'
                      example: true
                    Parcel:
                      type: object
                      description: 'The Parcel details'
                      example: []
                      properties:
                        Source:
                          type: string
                          description: 'Use “HERMES_CORP”.'
                          example: HERMES_CORP
                        ReasonForExport:
                          type: string
                          description: 'Reason for export'
                          example: debitis
                        TrackingNumber:
                          type: string
                          description: 'Hermes Assigned Tracking Number'
                          example: quis
                        Manifest:
                          type: boolean
                          description: ''
                          example: true
                        LabelType:
                          type: string
                          description: ''
                          example: optio
                        LabelFormat:
                          type: string
                          description: 'in:PNG,PDF,ZPL200,ZPL300'
                          example: qui
                        FulfilmentOrigin:
                          type: string
                          description: ''
                          example: nobis
                        ShipperReferenceID:
                          type: string
                          description: ''
                          example: et
                        CustomerReference1:
                          type: string
                          description: ''
                          example: sit
                        CustomerReference2:
                          type: string
                          description: ''
                          example: animi
                        Shipper:
                          type: object
                          description: 'The Shipper details'
                          example: []
                          properties:
                            AccountNumber:
                              type: string
                              description: 'Hermes Account Number, will be used to send back billing data'
                              example: doloremque
                            ContactName:
                              type: string
                              description: ''
                              example: ut
                            Company:
                              type: string
                              description: ''
                              example: temporibus
                            Address1:
                              type: string
                              description: ''
                              example: quaerat
                            Address2:
                              type: string
                              description: ''
                              example: repellat
                            Address3:
                              type: string
                              description: ''
                              example: animi
                            City:
                              type: string
                              description: ''
                              example: voluptas
                            Country:
                              type: string
                              description: ''
                              example: asperiores
                            Zip:
                              type: string
                              description: 'Required for Countries/Territories that use Zip/Postal codes'
                              example: qui
                            CountryCode:
                              type: string
                              description: 'ISO Country/Territory Code Eg. “GB”.'
                              example: ducimus
                            Phone:
                              type: string
                              description: ''
                              example: mollitia
                            Email:
                              type: email
                              description: ''
                              example: osbaldo94@example.net
                            Vat:
                              type: string
                              description: ''
                              example: velit
                            TaxID:
                              type: string
                              description: 'Norway VOEC / Import EORI number'
                              example: sapiente
                            Eori:
                              type: string
                              description: 'Shipper UK EORI Number'
                              example: voluptates
                            RegNumber:
                              type: string
                              description: 'Shipper OSS/IOSS Registration Number Required for IOSS shipments to destination EU'
                              example: molestias
                            Url:
                              type: string
                              description: 'Required for USA destination'
                              example: 'https://www.hilpert.com/ipsum-eos-possimus-illo-omnis-ullam-velit-voluptate'
                        Consignee:
                          type: object
                          description: 'The Consignee details'
                          example: []
                          properties:
                            ContactName:
                              type: string
                              description: ''
                              example: repellat
                            Company:
                              type: string
                              description: ''
                              example: maiores
                            Address1:
                              type: string
                              description: ''
                              example: adipisci
                            Address2:
                              type: string
                              description: ''
                              example: quis
                            Address3:
                              type: string
                              description: ''
                              example: et
                            City:
                              type: string
                              description: ''
                              example: dolorum
                            Country:
                              type: string
                              description: 'Required for USA and Canada destinations (Use 2 letter State Codes). Required for Australia destination (Use 2 / 3 letter state code).'
                              example: sed
                            Zip:
                              type: string
                              description: 'Required for Destination Countries/Territories that use Zip/Post codes.'
                              example: repellendus
                            CountryCode:
                              type: string
                              description: 'ISO Country/Territory Code.'
                              example: et
                            Phone:
                              type: string
                              description: 'Required for PUDO services and shipments going to HU, CZ, PL, SK and HR. (must be mobile), otherwise recommended. International format only (eg. +441268123456).'
                              example: veritatis
                            Email:
                              type: email
                              description: ''
                              example: kcarter@example.com
                            Vat:
                              type: string
                              description: ''
                              example: et
                            PudoID:
                              type: string
                              description: 'Required for PUDO services. Pickup ID of the pickup point.'
                              example: eligendi
                            NationalID:
                              type: string
                              description: ''
                              example: quisquam
                            PassportNumber:
                              type: string
                              description: 'Required depending on destination/route'
                              example: blanditiis
                            PassportIssueDate:
                              type: 'date_format:d/m/Y'
                              description: 'Required depending on destination/route, DD/MM/YYYY format'
                              example: dicta
                            PassportExpiryDate:
                              type: 'date_format:d/m/Y'
                              description: 'Required depending on destination/route, DD/MM/YYYY format'
                              example: nostrum
                            PassportIssuedBy:
                              type: string
                              description: 'Required depending on destination/route'
                              example: laboriosam
                            PassportIssueCountryCode:
                              type: string
                              description: 'Required depending on destination/route.'
                              example: GB
                            ContactNameLocal:
                              type: string
                              description: 'Required depending on destination/route'
                              example: ab
                            TaxID:
                              type: string
                              description: 'Required depending on destination/route'
                              example: qui
                        PaymentReferenceNumber:
                          type: string
                          description: 'Required depending on destination/route'
                          example: voluptatem
                        PaymentDateTime:
                          type: string
                          description: 'Required depending on destination/route Format: YYYY-MM-DD HH:MM:SS'
                          example: culpa
                        PaymentProvider:
                          type: string
                          description: 'Required depending on destination/route'
                          example: id
                        Service:
                          type: string
                          description: 'Use ‘HERMES_INTERNATIONAL’.'
                          example: HERMES_INTERNATIONAL
                        Collect:
                          type: string
                          description: ''
                          example: accusantium
                        Pieces:
                          type: string
                          description: 'Always “1”.'
                          example: '1'
                        Weight:
                          type: string
                          description: 'Eg. “3.02”.'
                          example: '3.02'
                        WeightUnit:
                          type: string
                          description: '“K” = Kg, “L” = Lbs.'
                          example: K
                        Length:
                          type: numeric
                          description: 'In Cms.'
                          example: '4'
                        Width:
                          type: numeric
                          description: 'In Cms.'
                          example: '4'
                        Height:
                          type: numeric
                          description: 'In Cms.'
                          example: '4'
                        DimUnit:
                          type: string
                          description: '“cm” only.'
                          example: cm
                        DescriptionOfGoods:
                          type: string
                          description: 'Overall Shipment Description'
                          example: amet
                        Value:
                          type: numeric
                          description: 'Overall Shipment Value'
                          example: accusantium
                        ShippingCost:
                          type: numeric
                          description: 'Overall Cost of Shipping'
                          example: eos
                        Currency:
                          type: string
                          description: 'ISO Currency Code.'
                          example: GBP
                        MerchantARN:
                          type: string
                          description: 'Merchant ARN required for GST calculation (Australia)'
                          example: aut
                        PurchaserABN:
                          type: string
                          description: 'Purchaser ABN If applicable (Australia)'
                          example: placeat
                        GSTExemptionCode:
                          type: string
                          description: 'If GST has not been charged, then provide the exemption code (Australia)'
                          example: quo
                        Terms:
                          type: string
                          description: '“DDU” or “DDP”.'
                          example: DDP
                        CODAmount:
                          type: numeric
                          description: 'Cash on Delivery Amount.'
                          example: '132.99'
                        CODCurrency:
                          type: string
                          description: 'Cash on Delivery Currency. 3 Characters. Example GBP'
                          example: placeat
                        DangerousGoods:
                          type: boolean
                          description: ''
                          example: false
                        ShipperBrandingID:
                          type: string
                          description: ''
                          example: quo
                        Items:
                          type: array
                          description: ''
                          example:
                            - []
                          items:
                            type: object
                            properties:
                              Description:
                                type: string
                                description: 'Required for outside EU'
                                example: 'Laudantium et quidem ab aperiam totam tempora quia.'
                              SkuCode:
                                type: string
                                description: 'For China and Russia, please populate with SKU Code'
                                example: dignissimos
                              HsCode:
                                type: string
                                description: 'For China Direct, please populate with HS Code'
                                example: harum
                              CountryOfOrigin:
                                type: string
                                description: 'ISO Country/Territory Code'
                                example: consequuntur
                              PurchaseUrl:
                                type: string
                                description: 'Direct link to the product required for Russia'
                                example: 'https://www.conroy.com/laborum-veritatis-sapiente-et-ullam'
                              ImageUrl:
                                type: string
                                description: 'Direct link to the product image'
                                example: 'https://oreilly.com/odio-qui-suscipit-est-earum.html'
                              Quantity:
                                type: numeric
                                description: 'Total number of pieces in this item Required for outside EU'
                                example: cum
                              Value:
                                type: numeric
                                description: 'Total value of this item (all pieces). Required for outside EU'
                                example: sequi
                              DetailedDescription:
                                type: string
                                description: 'Detailed description of the item'
                                example: voluptatum
                              ItemComposition:
                                type: string
                                description: 'Composition of the item.'
                                example: '100% Cotton'
                              DG:
                                type: object
                                description: 'Dangerous goods info (if present parcel''s DangerousGoods should be true)'
                                example: []
                                properties:
                                  Type:
                                    type: string
                                    description: 'Dangerous goods type. 2 Characters. Example LQ'
                                    example: quasi
                                  ProductType:
                                    type: string
                                    description: 'Dangerous goods product type. Example UN1266'
                                    example: et
                                  Capacity:
                                    type: numeric
                                    description: 'Capacity. 6 digits, 3 decimal points. Example 1.000'
                                    example: pariatur
                                  CapacityUOM:
                                    type: string
                                    description: 'CapacityUOM. “l“ = Litres, “ml“ = Millilitres, “g“ = Grams. Example g'
                                    example: voluptatem
              required:
                - CreateParcel
      security: []
  /api/v1/hermes/parcels/accept:
    post:
      summary: ''
      operationId: postApiV1HermesParcelsAccept
      description: ''
      parameters: []
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  code: Unauthorized
                properties:
                  code:
                    type: string
                    example: Unauthorized
      tags:
        - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                AcceptParcel:
                  type: object
                  description: ''
                  example: []
                  properties:
                    Apikey:
                      type: string
                      description: ''
                      example: ea
                    IsTest:
                      type: boolean
                      description: ''
                      example: true
                    Parcel:
                      type: object
                      description: ''
                      example: []
                      properties:
                        TrackingNumber:
                          type: string
                          description: ''
                          example: alias
                        ProcessedDateTime:
                          type: string
                          description: 'Must be a valid date.'
                          example: '2024-06-19T04:40:04'
                        Weight:
                          type: number
                          description: ''
                          example: 420426660.03
                        Height:
                          type: number
                          description: ''
                          example: 0.7576
                        Width:
                          type: number
                          description: ''
                          example: 13903229.08165
                        Length:
                          type: number
                          description: ''
                          example: 12408.69
              required:
                - AcceptParcel
      security: []
  /api/v1/hermes/determinerouting:
    post:
      summary: ''
      operationId: postApiV1HermesDeterminerouting
      description: ''
      parameters: []
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  code: Unauthorized
                properties:
                  code:
                    type: string
                    example: Unauthorized
      tags:
        - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                CreateParcel:
                  type: object
                  description: ''
                  example: []
                  properties:
                    Apikey:
                      type: string
                      description: 'API key'
                      example: in
                    IsTest:
                      type: boolean
                      description: 'Test mode flag. true - test mode'
                      example: true
                    Parcel:
                      type: object
                      description: 'The Parcel details'
                      example: []
                      properties:
                        Source:
                          type: string
                          description: 'Use “HERMES_CORP”.'
                          example: HERMES_CORP
                        ReasonForExport:
                          type: string
                          description: 'Reason for export'
                          example: tempora
                        TrackingNumber:
                          type: string
                          description: 'Hermes Assigned Tracking Number'
                          example: ut
                        Manifest:
                          type: boolean
                          description: ''
                          example: false
                        LabelType:
                          type: string
                          description: ''
                          example: aut
                        LabelFormat:
                          type: string
                          description: 'in:PNG,PDF,ZPL200,ZPL300'
                          example: debitis
                        FulfilmentOrigin:
                          type: string
                          description: ''
                          example: corporis
                        ShipperReferenceID:
                          type: string
                          description: ''
                          example: mollitia
                        CustomerReference1:
                          type: string
                          description: ''
                          example: atque
                        CustomerReference2:
                          type: string
                          description: ''
                          example: rerum
                        Shipper:
                          type: object
                          description: 'The Shipper details'
                          example: []
                          properties:
                            AccountNumber:
                              type: string
                              description: 'Hermes Account Number, will be used to send back billing data'
                              example: voluptas
                            ContactName:
                              type: string
                              description: ''
                              example: quia
                            Company:
                              type: string
                              description: ''
                              example: eos
                            Address1:
                              type: string
                              description: ''
                              example: qui
                            Address2:
                              type: string
                              description: ''
                              example: eaque
                            Address3:
                              type: string
                              description: ''
                              example: sit
                            City:
                              type: string
                              description: ''
                              example: non
                            Country:
                              type: string
                              description: ''
                              example: quia
                            Zip:
                              type: string
                              description: 'Required for Countries/Territories that use Zip/Postal codes'
                              example: nostrum
                            CountryCode:
                              type: string
                              description: 'ISO Country/Territory Code Eg. “GB”.'
                              example: est
                            Phone:
                              type: string
                              description: ''
                              example: ut
                            Email:
                              type: email
                              description: ''
                              example: weissnat.trent@example.com
                            Vat:
                              type: string
                              description: ''
                              example: ipsum
                            TaxID:
                              type: string
                              description: 'Norway VOEC / Import EORI number'
                              example: enim
                            Eori:
                              type: string
                              description: 'Shipper UK EORI Number'
                              example: optio
                            RegNumber:
                              type: string
                              description: 'Shipper OSS/IOSS Registration Number Required for IOSS shipments to destination EU'
                              example: est
                            Url:
                              type: string
                              description: 'Required for USA destination'
                              example: 'http://hodkiewicz.com/eligendi-officiis-in-saepe-aliquid-voluptas-et'
                        Consignee:
                          type: object
                          description: 'The Consignee details'
                          example: []
                          properties:
                            ContactName:
                              type: string
                              description: ''
                              example: est
                            Company:
                              type: string
                              description: ''
                              example: tempore
                            Address1:
                              type: string
                              description: ''
                              example: magnam
                            Address2:
                              type: string
                              description: ''
                              example: tenetur
                            Address3:
                              type: string
                              description: ''
                              example: quod
                            City:
                              type: string
                              description: ''
                              example: vitae
                            Country:
                              type: string
                              description: 'Required for USA and Canada destinations (Use 2 letter State Codes). Required for Australia destination (Use 2 / 3 letter state code).'
                              example: excepturi
                            Zip:
                              type: string
                              description: 'Required for Destination Countries/Territories that use Zip/Post codes.'
                              example: totam
                            CountryCode:
                              type: string
                              description: 'ISO Country/Territory Code.'
                              example: itaque
                            Phone:
                              type: string
                              description: 'Required for PUDO services and shipments going to HU, CZ, PL, SK and HR. (must be mobile), otherwise recommended. International format only (eg. +441268123456).'
                              example: at
                            Email:
                              type: email
                              description: ''
                              example: carson25@example.com
                            Vat:
                              type: string
                              description: ''
                              example: quia
                            PudoID:
                              type: string
                              description: 'Required for PUDO services. Pickup ID of the pickup point.'
                              example: quam
                            NationalID:
                              type: string
                              description: ''
                              example: et
                            PassportNumber:
                              type: string
                              description: 'Required depending on destination/route'
                              example: iusto
                            PassportIssueDate:
                              type: 'date_format:d/m/Y'
                              description: 'Required depending on destination/route, DD/MM/YYYY format'
                              example: qui
                            PassportExpiryDate:
                              type: 'date_format:d/m/Y'
                              description: 'Required depending on destination/route, DD/MM/YYYY format'
                              example: non
                            PassportIssuedBy:
                              type: string
                              description: 'Required depending on destination/route'
                              example: est
                            PassportIssueCountryCode:
                              type: string
                              description: 'Required depending on destination/route.'
                              example: GB
                            ContactNameLocal:
                              type: string
                              description: 'Required depending on destination/route'
                              example: molestiae
                            TaxID:
                              type: string
                              description: 'Required depending on destination/route'
                              example: culpa
                        PaymentReferenceNumber:
                          type: string
                          description: 'Required depending on destination/route'
                          example: quia
                        PaymentDateTime:
                          type: string
                          description: 'Required depending on destination/route Format: YYYY-MM-DD HH:MM:SS'
                          example: non
                        PaymentProvider:
                          type: string
                          description: 'Required depending on destination/route'
                          example: occaecati
                        Service:
                          type: string
                          description: 'Use ‘HERMES_INTERNATIONAL’.'
                          example: HERMES_INTERNATIONAL
                        Collect:
                          type: string
                          description: ''
                          example: sit
                        Pieces:
                          type: string
                          description: 'Always “1”.'
                          example: '1'
                        Weight:
                          type: string
                          description: 'Eg. “3.02”.'
                          example: '3.02'
                        WeightUnit:
                          type: string
                          description: '“K” = Kg, “L” = Lbs.'
                          example: K
                        Length:
                          type: numeric
                          description: 'In Cms.'
                          example: '4'
                        Width:
                          type: numeric
                          description: 'In Cms.'
                          example: '4'
                        Height:
                          type: numeric
                          description: 'In Cms.'
                          example: '4'
                        DimUnit:
                          type: string
                          description: '“cm” only.'
                          example: cm
                        DescriptionOfGoods:
                          type: string
                          description: 'Overall Shipment Description'
                          example: voluptates
                        Value:
                          type: numeric
                          description: 'Overall Shipment Value'
                          example: ad
                        ShippingCost:
                          type: numeric
                          description: 'Overall Cost of Shipping'
                          example: dolores
                        Currency:
                          type: string
                          description: 'ISO Currency Code.'
                          example: GBP
                        MerchantARN:
                          type: string
                          description: 'Merchant ARN required for GST calculation (Australia)'
                          example: qui
                        PurchaserABN:
                          type: string
                          description: 'Purchaser ABN If applicable (Australia)'
                          example: qui
                        GSTExemptionCode:
                          type: string
                          description: 'If GST has not been charged, then provide the exemption code (Australia)'
                          example: quam
                        Terms:
                          type: string
                          description: '“DDU” or “DDP”.'
                          example: DDP
                        CODAmount:
                          type: numeric
                          description: 'Cash on Delivery Amount.'
                          example: '132.99'
                        CODCurrency:
                          type: string
                          description: 'Cash on Delivery Currency. 3 Characters. Example GBP'
                          example: provident
                        DangerousGoods:
                          type: boolean
                          description: ''
                          example: true
                        ShipperBrandingID:
                          type: string
                          description: ''
                          example: dolorum
                        Items:
                          type: array
                          description: ''
                          example:
                            - []
                          items:
                            type: object
                            properties:
                              Description:
                                type: string
                                description: 'Required for outside EU'
                                example: 'Facere eius non error quidem.'
                              SkuCode:
                                type: string
                                description: 'For China and Russia, please populate with SKU Code'
                                example: dignissimos
                              HsCode:
                                type: string
                                description: 'For China Direct, please populate with HS Code'
                                example: qui
                              CountryOfOrigin:
                                type: string
                                description: 'ISO Country/Territory Code'
                                example: ut
                              PurchaseUrl:
                                type: string
                                description: 'Direct link to the product required for Russia'
                                example: 'http://www.mcglynn.net/animi-eum-ut-harum-architecto-aspernatur.html'
                              ImageUrl:
                                type: string
                                description: 'Direct link to the product image'
                                example: 'http://blanda.info/sunt-repellat-quas-aperiam-vel-et-et.html'
                              Quantity:
                                type: numeric
                                description: 'Total number of pieces in this item Required for outside EU'
                                example: voluptatem
                              Value:
                                type: numeric
                                description: 'Total value of this item (all pieces). Required for outside EU'
                                example: quia
                              DetailedDescription:
                                type: string
                                description: 'Detailed description of the item'
                                example: et
                              ItemComposition:
                                type: string
                                description: 'Composition of the item.'
                                example: '100% Cotton'
                              DG:
                                type: object
                                description: 'Dangerous goods info (if present parcel''s DangerousGoods should be true)'
                                example: []
                                properties:
                                  Type:
                                    type: string
                                    description: 'Dangerous goods type. 2 Characters. Example LQ'
                                    example: nisi
                                  ProductType:
                                    type: string
                                    description: 'Dangerous goods product type. Example UN1266'
                                    example: adipisci
                                  Capacity:
                                    type: numeric
                                    description: 'Capacity. 6 digits, 3 decimal points. Example 1.000'
                                    example: porro
                                  CapacityUOM:
                                    type: string
                                    description: 'CapacityUOM. “l“ = Litres, “ml“ = Millilitres, “g“ = Grams. Example g'
                                    example: quod
              required:
                - CreateParcel
      security: []
  '/api/v1/hermes/automation-testing/parcels/{searchNumber}':
    get:
      summary: ''
      operationId: getApiV1HermesAutomationTestingParcelsSearchNumber
      description: ''
      parameters: []
      responses:
        400:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  errors:
                    - 'Malformed json content given'
                properties:
                  errors:
                    type: array
                    example:
                      - 'Malformed json content given'
                    items:
                      type: string
      tags:
        - Endpoints
      security: []
    parameters:
      -
        in: path
        name: searchNumber
        description: ''
        example: aliquid
        required: true
        schema:
          type: string
  /api/v1/hermes/automation-testing/parcels:
    patch:
      summary: 'Change status of the parcel for QA purposes.'
      operationId: changeStatusOfTheParcelForQAPurposes
      description: ''
      parameters: []
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  code: Unauthorized
                properties:
                  code:
                    type: string
                    example: Unauthorized
      tags:
        - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                UpdateParcel:
                  type: object
                  description: ''
                  example: []
                  properties:
                    Parcels:
                      type: array
                      description: ''
                      example:
                        - adipisci
                      items:
                        type: string
                    Parcel:
                      type: object
                      description: ''
                      example:
                        ShipperReferenceID: animi
                      properties:
                        ShipperReferenceID:
                          type: string
                          description: ''
                          example: animi
                        TrackingNumber:
                          type: string
                          description: ''
                          example: tenetur
                        Status:
                          type: integer
                          description: ''
                          example: 8
              required:
                - UpdateParcel
      security: []
  /api/v1/hermes/tracking:
    post:
      summary: 'Get tracking history for parcels.'
      operationId: getTrackingHistoryForParcels
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  TrackParcelResponse:
                    Parcels:
                      -
                        TrackingNumber: ''
                        ShipmentReferenceID: ''
                        CarrierTrackingNumber: ''
                        CarrierTrackingURL: ''
                        ServiceName: ''
                        CarrierName: ''
                        Weight: 0.0
                        WeightUOM: ''
                        OriginHub: ''
                        Events:
                          -
                            EventDateTime: '2000-01-01 00:00:00'
                            TrackingCode: 0
                            Description: ''
                            Location: ''
                      -
                        TrackingNumber: ''
                        Error: 'Parcel not found'
                    ErrorLevel: 0
                    Error: null
                properties:
                  TrackParcelResponse:
                    type: object
                    properties:
                      Parcels:
                        type: array
                        example:
                          -
                            TrackingNumber: ''
                            ShipmentReferenceID: ''
                            CarrierTrackingNumber: ''
                            CarrierTrackingURL: ''
                            ServiceName: ''
                            CarrierName: ''
                            Weight: 0
                            WeightUOM: ''
                            OriginHub: ''
                            Events:
                              -
                                EventDateTime: '2000-01-01 00:00:00'
                                TrackingCode: 0
                                Description: ''
                                Location: ''
                          -
                            TrackingNumber: ''
                            Error: 'Parcel not found'
                        items:
                          type: object
                          properties:
                            TrackingNumber:
                              type: string
                              example: ''
                            ShipmentReferenceID:
                              type: string
                              example: ''
                            CarrierTrackingNumber:
                              type: string
                              example: ''
                            CarrierTrackingURL:
                              type: string
                              example: ''
                            ServiceName:
                              type: string
                              example: ''
                            CarrierName:
                              type: string
                              example: ''
                            Weight:
                              type: number
                              example: 0.0
                            WeightUOM:
                              type: string
                              example: ''
                            OriginHub:
                              type: string
                              example: ''
                            Events:
                              type: array
                              example:
                                -
                                  EventDateTime: '2000-01-01 00:00:00'
                                  TrackingCode: 0
                                  Description: ''
                                  Location: ''
                              items:
                                type: object
                                properties:
                                  EventDateTime:
                                    type: string
                                    example: '2000-01-01 00:00:00'
                                  TrackingCode:
                                    type: integer
                                    example: 0
                                  Description:
                                    type: string
                                    example: ''
                                  Location:
                                    type: string
                                    example: ''
                      ErrorLevel:
                        type: integer
                        example: 0
                      Error:
                        type: string
                        example: null
      tags:
        - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                TrackParcel:
                  type: object
                  description: ''
                  example: []
                  properties:
                    Apikey:
                      type: string
                      description: 'API key'
                      example: numquam
                    Parcels:
                      type: array
                      description: 'List of Tracking numbers to search by'
                      example:
                        - sed
                      items:
                        type: string
              required:
                - TrackParcel
      security: []
  /api/v1/hermes/pudo:
    get:
      summary: 'Get PUDO points'
      operationId: getPUDOPoints
      description: ''
      parameters:
        -
          in: query
          name: page
          description: ''
          example: 12
          required: false
          schema:
            type: integer
            description: ''
            example: 12
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n   'PudoResponse': {\n       'Pudo': [\n           {\n               'PudoId': '',\n               'Alias': '',\n               'Title': '',\n               'Country': '',\n               'State': '',\n               'Zip': '',\n               'City': '',\n               'Addr1': '',\n               'Addr2': '',\n               'Addr3': '',\n               'Lat': 0.0\n               'Lng': 0.0\n               'ShippingAPIServiceId': [],\n               'AvailableServices': [],\n               'AvailableLabelFormats': [],\n               'WorkHours': {},\n               'Additional': {},\n           },\n       ],\n       'Page': 1,\n       'LastPage': 2,\n   }\n}"
      tags:
        - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Pudo:
                  type: object
                  description: ''
                  example: []
                  properties:
                    Apikey:
                      type: string
                      description: 'API key'
                      example: modi
                    PudoId:
                      type: string
                      description: 'PUDO ID'
                      example: odio
                    CarrierCode:
                      type: string
                      description: ''
                      example: et
                    CarrierId:
                      type: integer
                      description: ''
                      example: 6
                    ShippingAPIServiceId:
                      type: integer
                      description: ''
                      example: 14
                    PerPage:
                      type: integer
                      description: 'PUDO points per page'
                      example: 2
                    Page:
                      type: integer
                      description: PUDO
                      example: 20
                    Address:
                      type: object
                      description: ''
                      example: []
                      properties:
                        Country:
                          type: string
                          description: ''
                          example: qui
                        State:
                          type: string
                          description: ''
                          example: illum
                        Zip:
                          type: string
                          description: ''
                          example: qui
                        City:
                          type: string
                          description: ''
                          example: distinctio
                        Addr1:
                          type: string
                          description: ''
                          example: est
                        Addr2:
                          type: string
                          description: ''
                          example: et
                        Addr3:
                          type: string
                          description: ''
                          example: eum
              required:
                - Pudo
      security: []
  /api/v1/hermes/pudo/locate:
    get:
      summary: 'Locate stores by country and zip'
      operationId: locateStoresByCountryAndZip
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n   'LocateStoreResponse': {\n       'Stores': [\n           {\n               'ID': '',\n               'Carrier': '',\n               'Name': '',\n               'Address1': '',\n               'Address2': '',\n               'Address3': '',\n               'City': '',\n               'State': '',\n               'ZipCode': '',\n               'CountryCode': '',\n               'Latitude': 0.0\n               'Longitude': 0.0\n               'OpeningTimes': [],\n           }\n       ]\n   }\n}"
      tags:
        - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                LocateStore:
                  type: object
                  description: ''
                  example: []
                  properties:
                    Apikey:
                      type: string
                      description: 'API key'
                      example: nihil
                    CountryCode:
                      type: string
                      description: ''
                      example: eum
                    ZipCode:
                      type: string
                      description: ''
                      example: labore
              required:
                - LocateStore
      security: []
tags:
  -
    name: Endpoints
    description: ''
