---
swagger: "2.0"
info:
  description: Shipwire's Warehouses API
  version: "3.0"
  title: Shipwire Warehouses API
host: api.shipwire.com
basePath: /
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- basicAuth: []
paths:
  /api/v3.1/warehouses:
    get:
      summary: Get warehouses
      description: Get a collection of warehouses
      operationId: getApiV31Warehouses
      produces:
      - application/json
      parameters:
      - name: id
        in: query
        description: Filter by warehouse ids, supports comma separated list
        required: false
        type: integer
      - name: externalId
        in: query
        description: Filter by warehouse external ids, supports comma separated list
        required: false
        type: string
      - name: name
        in: query
        description: Filter by warehouse names, supports comma separated list
        required: false
        type: string
      - name: vendorId
        in: query
        description: Filter by associated vendor's id, supports comma separated list
        required: false
        type: integer
      - name: vendorExternalId
        in: query
        description: Filter by associated vendor's external id, supports comma separated list
        required: false
        type: string
      - name: country
        in: query
        description: Filter by country, supports comma separated list
        required: false
        type: string
      - name: generatesLabels
        in: query
        description: Filter by warehouses that require label generation
        required: false
        type: string
      - name: type
        in: query
        description: Filter by type ("SHIPWIRE", "SHIPWIRE_ANYWHERE")
        required: false
        type: string
        enum:
        - SHIPWIRE
        - SHIPWIRE_ANYWHERE
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/GetWarehousesResponse'
    post:
      summary: Create a new warehouse
      description: Create a new warehouse
      operationId: postApiV31Warehouse
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: ""
        required: true
        schema:
          $ref: '#/definitions/CreateANewWarehouseRequest'
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/CreateANewWarehouseResponse'
  /api/v3.1/warehouses/{id}:
    get:
      summary: Get a warehouse
      description: Get a warehouse by id or external id.
      operationId: ApiV31WarehousesByIdGet
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: The warehouse id or external id.
        required: true
        type: string
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/GetAWarehouseResponse'
    put:
      summary: Update a warehouse
      description: Modify a warehouse based on its id or external id
      operationId: ApiV31WarehousesByIdPut
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: The warehouse's id or external id.
        required: true
        type: string
      - in: body
        name: body
        description: ""
        required: true
        schema:
          $ref: '#/definitions/UpdateAWarehouseRequest'
      responses:
        200:
          description: ""
          schema:
            $ref: '#/definitions/CreateANewWarehouseResponse'
  /api/v3.1/warehouses/{id}/retire:
    post:
      summary: Retire a warehouse
      description: Indicates that the warehouse will not longer be used. If the warehouse is not associated with any active vendors or orders, the warehouse will be deleted. Otherwise the warehouse will have its "isActive" property set to false.
      operationId: ApiV31WarehousesRetireByIdPost
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: Warehouse id or external id
        required: true
        type: string
      responses:
        200:
          description: ""
          schema:
            $ref: '#/definitions/RetireAWarehouseResponse'
        404:
          description: Unexpected error in API call. See HTTP response body for details.
          schema:
            $ref: '#/definitions/RetireAWarehouse404Response'
  /api/v3.1/warehouses/{id}/containers:
    get:
      summary: Get containers associated with a warehouse
      description: ""
      operationId: GetApiV31WarehousesContainersById
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: The warehouse id or external id.
        required: true
        type: string
      responses:
        200:
          description: ""
          schema:
            $ref: '#/definitions/GetContainersAssociatedWithAWarehouseResponse'
  /api/v3.1/warehouses/{id}/carriers:
    get:
      summary: Get carriers associated with a warehouse
      description: Returns a list of carriers associated with the specified warehouse.
      operationId: GetApiV31WarehousesCarriersById
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: The warehouse id or external id.
        required: true
        type: string
      responses:
        200:
          description: ""
          schema:
            $ref: '#/definitions/GetCarriersResponse'
  /api/v3.1/warehouses/{id}/addCarriers:
    post:
      summary: Add carriers to a warehouse
      description: Creates the association of a carrier with the specified warehouse.
      operationId: ApiV31WarehousesAddCarriersByIdPost
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: Warehouse id or external id.
        required: true
        type: string
      - in: body
        name: body
        description: ""
        required: true
        schema:
          $ref: '#/definitions/AddCarrierRequest'
      responses:
        200:
          description: ""
          schema:
            $ref: '#/definitions/GetCarriersResponse'
  /api/v3.1/warehouses/{id}/removeCarriers:
    post:
      summary: Remove carriers to a warehouse
      description: Removes the association of a carrier with the specified warehouse, and returns the list of updated carriers supported for the warehouse.
      operationId: ApiV31WarehousesRemoveCarriersByIdPost
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: Warehouse id or external id.
        required: true
        type: string
      - in: body
        name: body
        description: ""
        required: true
        schema:
          $ref: '#/definitions/RemoveCarrierRequest'
      responses:
        200:
          description: ""
          schema:
            $ref: '#/definitions/GetCarriersResponse'
securityDefinitions:
  basicAuth:
    type: basic
definitions:
  WarehouseServerResponse:
    type: object
    properties:
      status:
        type: integer
        example: 200
        description: This is the HTTP status code.
      message:
        type: string
        example: Successful
        description: This is the HTTP status message.
    title: Warehouse Server Response
    description: Get Warehouses Response based on the criteria provided in the URL
  WarehouserPaginationResponse:
    type: object
    properties:
      offset:
        type: integer
        example: 0
        description: This is an integer that matches the offset given in the request and dictates the number of items to skip while fetching results. For example, there is a preset limit of 20 results per page. If there are 30 total results and offset is set to 20, then the response will show the second "page" of results, with items 21 to 30.
      total:
        type: integer
        example: 1
        description: Total number of available items in the API response.
      previous:
        type: string
        example: null
        description: A link used to fetch the previous set or page of items in the API response.
      next:
        type: string
        example: null
        description: A link used to fetch the next set or page of items in the API response.
    title: Warehouse Pagination Response
    description: Server Pagination Response
  GetWarehousesResponse:
    allOf:
    - $ref: '#/definitions/WarehouseServerResponse'
    - title: Get Warehouses Response
    - description: Get Warehouses Response based on the criteria provided in the URL
    - type: object
  GetCarriersResponse:
    allOf:
    - $ref: '#/definitions/WarehouseServerResponse'
    - title: Get Carriers Response
    - description: Get Carriers Response based on the criteria provided in the URL
    - type: object
  PostWarehouseRequest:
    type: object
    required:
    - address
    - isActive
    - labelFormat
    - name
    properties:
      externalId:
        type: string
        example: "3"
        description: A unique user-provided identifier for the warehouse in an external system.
        minLength: 1
        maxLength: 32
      name:
        type: string
        example: West Coast DC
        description: Name of the warehouse
        minLength: 1
        maxLength: 50
      code:
        type: string
        example: RCKTS
        description: This is the code assigned to the warehouse for easy reference.
        minLength: 1
        maxLength: 25
      vendorId:
        type: integer
        example: null
        description: A unique ID assigned to each vendor in the Shipwire system. (See the Vendors API.)
      vendorExternalId:
        type: string
        example: null
        description: A unique user provided identifier for a vendor in an external system.
      isActive:
        type: integer
        example: 1
        description: A boolean which indicates whether or not the warehouse is available to the customer for storage, shipping and receiving inventory.
      address: {}
      latitude:
        type: number
        format: float
        example: 37.7915
        description: Latitude of the warehouse. This is useful for routing purposes to find the nearest warehouse.
        minimum: -90
        maximum: 90
      longitude:
        type: number
        format: float
        example: -122.402
        description: Longitude of the warehouse. This is useful for routing purposes to find the nearest warehouse.
        minimum: -180
        maximum: 180
      isRoutable:
        type: integer
        example: 1
        description: A boolean which indicates whether orders may be routed to this warehouse by our routing engine.
      labelFormat:
        type: string
        example: 8.5x11
        description: This is the generic format of the label that the warehouse generates for each customer
        enum:
        - 4x6
        - 8.5x11
      generatesLabels:
        type: integer
        example: 1
        description: A boolean which indicates whether or not the warehouse can generate shipping labels. These labels are stored on the server and can be given to the customer if required
      returnWarehouseId:
        type: integer
        example: 11
        description: This is the unique ID of the Shipwire warehouse used for RMA process and will store returned goods.
      returnWarehouseExternalId:
        type: string
        example: null
        description: This is the external ID of the Shipwire warehouse used for RMA process.
        minLength: 1
        maxLength: 11
    title: Post request to create a new warehouse
    description: Sample Post request to create a new warehouse
  CreateANewWarehouseRequest:
    title: Create a New Warehouse Request
    allOf:
    - $ref: '#/definitions/PostWarehouseRequest'
    - {}
    description: Create a New Shipwire Anywhere Warehouse
  CreateANewWarehouseResponse:
    allOf:
    - $ref: '#/definitions/WarehouseServerResponse'
    - title: Create a New Warehouse Response
    - description: Response for new Shipwire Anhywhere Warehouse creation
    - type: object
  GetAWarehouseResponse:
    allOf:
    - $ref: '#/definitions/WarehouseServerResponse'
    - title: Get a Warehouse Response
    - description: Get a Warehouse information for the mentioned ID
    - type: object
  UpdateAWarehouseRequest:
    type: object
    properties:
      externalId:
        type: string
        example: "3"
        description: A unique user-provided identifier for the warehouse in an external system.
        minLength: 1
        maxLength: 32
      name:
        type: string
        example: West Coast DC
        description: Name of the warehouse
        minLength: 1
        maxLength: 50
      code:
        type: string
        example: RCKTS
        description: This is the code assigned to the warehouse for easy reference.
        minLength: 1
        maxLength: 25
      vendorId:
        type: integer
        example: null
        description: A unique ID assigned to each vendor in the Shipwire system. (See the Vendors API.)
      vendorExternalId:
        type: string
        example: null
        description: A unique user provided identifier for a vendor in an external system.
      isActive:
        type: integer
        example: 1
        description: A boolean which indicates whether or not the warehouse is available to the customer for storage, shipping and receiving inventory.
      address:
        $ref: '#/definitions/WarehouseAddress'
      latitude:
        type: number
        format: float
        example: 37.7915
        description: Latitude of the warehouse. This is useful for routing purposes to find the nearest warehouse.
        minimum: -90
        maximum: 90
      longitude:
        type: number
        format: float
        example: -122.402
        description: Longitude of the warehouse. This is useful for routing purposes to find the nearest warehouse.
        minimum: -180
        maximum: 180
      isRoutable:
        type: integer
        example: 1
        description: A boolean which indicates whether orders may be routed to this warehouse by our routing engine.
      generatesLabels:
        type: integer
        example: 1
        description: A boolean which indicates whether or not the warehouse can generate shipping labels. These labels are stored on the server and can be given to the customer if required
      returnWarehouseId:
        type: string
        example: "11"
        description: This is the unique ID of the Shipwire warehouse used for RMA process and will store returned goods.
        minLength: 1
        maxLength: 11
      returnWarehouseExternalId:
        type: string
        example: null
        description: This is the external ID of the Shipwire warehouse used for RMA process.
        minLength: 1
        maxLength: 11
    title: Update a Warehouse Request
    description: Update Shipwire Warehouse Information
  RetireAWarehouseResponse:
    properties:
      status:
        type: integer
        example: 200
        description: This is the HTTP status code.
      message:
        type: string
        example: Deleted
        description: This is the HTTP status message.
        minLength: 6
        maxLength: 30
      resourceLocation:
        type: string
        example: null
        description: A URL that gives more information about the linked resource. A "null" value would mean that no further information is available for that resource.
    title: Retire a Warehouse Response
    description: Delete Shipwire Anywhere Warehouse from the system
  RetireAWarehouse404Response:
    type: object
    properties:
      status:
        type: integer
        format: int32
        example: 404
        description: This is the HTTP status code.
        x-nullable: true
      message:
        type: string
        example: Warehouse not found
        description: This is the HTTP status message.
      resourceLocation:
        type: string
        example: https://api.shipwire.com/api/v3.1/warehouses?offset=0&limit=1
        description: A URL that gives more information about the linked resource. A "null" value would mean that no further information is available for that resource.
    title: Retire a warehouse 404 response
  GetContainersAssociatedWithAWarehouseResponse:
    type: object
    properties:
      status:
        type: integer
        example: 200
        description: This is the HTTP status code.
      message:
        type: string
        example: Successful
        description: This is the HTTP status message.
      resourceLocation:
        type: string
        example: https://api.shipwire.com/api/v3.1/containers?offset=0&limit=20
        description: A URL that gives more information about the linked resource. A "null" value would mean that no further information is available for that resource.
      resource:
        $ref: '#/definitions/GetContainersAssociatedWithAWarehouseResponse_resource'
    title: Get containers associated with a warehouse response
    description: Get list of containers associated with Warehouse. This contains information for both Shipwire and Shipwire anywhere Warehouse
  WarehouseAddress:
    type: object
    required:
    - address1
    - city
    - country
    - name
    - phone
    - postalCode
    - state
    properties:
      address1:
        type: string
        example: 1409 S Lilac Ave
        description: This is the first line of the address of the warehouse.
        minLength: 1
        maxLength: 32
      address2:
        type: string
        example: ""
        description: This is the second line of the address of the warehouse.
        minLength: 0
        maxLength: 35
      address3:
        type: string
        example: ""
        description: This is the third line of the address of the warehouse.
        minLength: 0
        maxLength: 35
      city:
        type: string
        example: Bloomington
        description: City where the warehouse is located.
        maxLength: 35
      state:
        type: string
        example: CA
        description: State where the warehouse is located.
        minLength: 2
        maxLength: 3
      postalCode:
        type: string
        example: "92316"
        description: Postal code of the warehouse
        maxLength: 10
        pattern: /^[0-9]{5}(?:-[0-9]{4})?$/
      country:
        type: string
        example: US
        description: 2 digit country code of the warehouse
      continent:
        type: string
        format: enum
        example: NORTH_AMERICA
        description: Name of the continent where the warehouse is located.
        enum:
        - NORTH_AMERICA
        - SOUTH_AMERICA
        - EUROPE
        - AFRICA
        - ASIA
        - AUSTRALIA
        - ANTARCTICA
      name:
        type: string
        example: NGL Bloomington
        description: Name of the warehouse
        minLength: 1
        maxLength: 32
      email:
        type: string
        example: foo@bar.com
        description: Email address of contact at the warehouse for any communication
      phone:
        type: string
        example: 650-561-4800
        description: Contact phone number of the warehouse for any communication
        minLength: 1
        maxLength: 50
      fax:
        type: string
        example: null
        description: Contact fax number of the warehouse for any communication
        minLength: 1
        maxLength: 50
    title: Warehouse Address
    description: Shipwire Anywhere Warehouse Address
  WarehouseInformation:
    type: object
    properties:
      id:
        type: integer
        example: 11
        description: A unique auto-generated ID assigned to each new warehouse added to the Shipwire Platform.
      externalId:
        type: string
        example: "3"
        description: A unique user-provided identifier for the warehouse in an external system.
        minLength: 1
        maxLength: 32
      name:
        type: string
        example: LA
        description: Name of the warehouse
        minLength: 1
        maxLength: 50
      code:
        type: string
        example: LAX3
        description: This is the code assigned to the warehouse for easy reference.
        minLength: 1
        maxLength: 25
      vendorId:
        type: integer
        example: null
        description: A unique ID assigned to each vendor in the Shipwire system. (See the Vendors API.)
      vendorExternalId:
        type: string
        example: null
        description: A unique user provided identifier for a vendor in an external system.
      isActive:
        type: integer
        format: enum
        example: 1
        description: A boolean which indicates whether or not the warehouse is available to the customer for storage, shipping and receiving inventory.
      address:
        $ref: '#/definitions/WarehouseInformation_address'
      latitude:
        type: number
        format: float
        example: 37.7915
        description: Latitude of the warehouse. This is useful for routing purposes to find the nearest warehouse.
        minimum: -90
        maximum: 90
      longitude:
        type: number
        format: float
        example: -122.402
        description: Longitude of the warehouse. This is useful for routing purposes to find the nearest warehouse.
        minimum: -180
        maximum: 180
      isRoutable:
        type: integer
        format: enum
        example: 1
        description: A boolean which indicates whether orders may be routed to this warehouse by our routing engine.
      generatesLabels:
        type: integer
        format: enum
        example: 1
        description: A boolean which indicates whether or not the warehouse can generate shipping labels. These labels are stored on the server and can be given to the customer if required
      type:
        type: string
        format: enum
        example: SHIPWIRE
        description: This is the type of the warehouse. It can be Shipwire or Shipwire Anywhere.
        enum:
        - SHIPWIRE
        - SHIPWIRE_ANYWHERE
      labelFormat:
        type: string
        format: enum
        example: 8.5x11
        description: This is the generic format of the label that the warehouse generates for each customer
        enum:
        - 4x6
        - 8.5x11
      combineShippingDocuments:
        type: boolean
        example: false
        description: This warehouse property ensures all shipping labels generated are a combination of packing list and label.
      returnWarehouseId:
        type: string
        example: "11"
        description: This is the unique ID of the Shipwire warehouse used for RMA process and will store returned goods.
        minLength: 1
        maxLength: 11
      returnWarehouseExternalId:
        type: string
        example: null
        description: This is the external ID of the Shipwire warehouse used for RMA process.
        minLength: 1
        maxLength: 11
      physicalWarehouseId:
        type: integer
        example: 5011
        description: A shipwire warehouse ID used to identify a specific physical warehouse that corresponds to a Shipwire Anywhere warehouse and is useful in consolidating inventory. If the SKU item is at a Shipwire warehouse, then this will be "null".
      containers:
        $ref: '#/definitions/WarehouseInformation_containers'
      carriers:
        type: string
        example: null
        description: These are customizations to carrier settings (ex. FDX 1D) specific to a warehouse. May relate to destination/origin country & zip code, max shipment dimensions & carrier capabilities etc.
    title: Warehouse Information
    description: Warehouse resource information
  CarrierResourceLocation:
    type: object
    properties:
      resourceLocation:
        type: string
        example: https://api.shipwire.com/api/v3.1/carriers/ABM-PLITE
        description: A URL that gives more information about the linked resource. A "null" value would mean that no further information is available for that resource.
      resource:
        $ref: '#/definitions/GetCarrierProperties'
    title: Carrier Resource Location
    description: Carrier Resource Location
  GetWarehouseResources:
    type: object
    properties:
      offset:
        type: integer
        example: 0
        description: This is an integer that matches the offset given in the request and dictates the number of items to skip while fetching results. For example, there is a preset limit of 20 results per page. If there are 30 total results and offset is set to 20, then the response will show the second "page" of results, with items 21 to 30.
      total:
        type: integer
        example: 1
        description: Total number of available items in the API response.
      previous:
        type: string
        example: null
        description: A link used to fetch the previous set or page of items in the API response.
      next:
        type: string
        example: null
        description: A link used to fetch the next set or page of items in the API response.
      items:
        type: array
        items:
          $ref: '#/definitions/GetWarehouseResources_items'
    title: Warehouse Resources
    description: Warehouse Resources
  CarrierResources:
    type: object
    properties:
      offset:
        type: integer
        example: 0
        description: This is an integer that matches the offset given in the request and dictates the number of items to skip while fetching results. For example, there is a preset limit of 20 results per page. If there are 30 total results and offset is set to 20, then the response will show the second "page" of results, with items 21 to 30.
      total:
        type: integer
        example: 1
        description: Total number of available items in the API response.
      previous:
        type: string
        example: null
        description: A link used to fetch the previous set or page of items in the API response.
      next:
        type: string
        example: null
        description: A link used to fetch the next set or page of items in the API response.
      items:
        type: array
        items:
          type: object
          properties: {}
    title: Carrier Resources
    description: Carrier Resources
  ContainerDimensions:
    type: object
    properties:
      length:
        type: number
        format: float
        example: 5.0
        description: This is the length of the container based on its Unit of Measurement (lengthUnit)
        minimum: 0.1
        maximum: 108
      width:
        type: number
        format: float
        example: 5.0
        description: This is the width of the container based on its Unit of Measurement (widthUnit)
        minimum: 0.1
        maximum: 108
      height:
        type: number
        format: float
        example: 1.0
        description: This is the width of the container based on its Unit of Measurement (widthUnit)
        minimum: 0.1
        maximum: 108
      weight:
        type: number
        format: float
        example: 0.0
        description: This is the weight of the container based on its Unit of Measurement (weightUnit)
        minimum: 0.1
        maximum: 108
      maxWeight:
        type: number
        format: float
        example: 150.0
        description: This is the maximum weight that the container can hold based on its Unit of Measurement (maxWeightUnit)
        minimum: 0.1
        maximum: 108
      lengthUnit:
        type: string
        format: enum
        example: IN
        description: This is the Unit of Measurement for Container length (e.g. inches)
        enum:
        - IN
        - CM
      widthUnit:
        type: string
        format: enum
        example: IN
        description: This is the Unit of Measurement for Container width (e.g. inches)
        enum:
        - IN
        - CM
      heightUnit:
        type: string
        format: enum
        example: IN
        description: This is the Unit of Measurement for Container height (e.g. inches)
        enum:
        - IN
        - CM
      weightUnit:
        type: string
        format: enum
        example: LB
        description: This is the Unit of Measurement for Container weight (e.g. pounds)
        enum:
        - LB
        - KG
      maxWeightUnit:
        type: string
        format: enum
        example: LB
        description: This is the Unit of Measurement for Container's max weight (e.g. pounds)
        enum:
        - LB
        - KG
    title: Container Dimensions
  ResourceDimensionValues:
    type: object
    properties:
      id:
        type: integer
        example: 268041
        description: A unique auto-generated ID assigned to each new container added to the Shipwire Platform.
      externalId:
        type: string
        example: null
        description: A unique user-provided identifier for a container in an external system.
        minLength: 1
        maxLength: 32
      name:
        type: string
        example: Small Box
        description: A unique identifier for the container in the Shipwire system.
        minLength: 1
        maxLength: 50
      type:
        type: string
        format: enum
        example: box
        description: This is the type of container based on the contents stored in it.
        minLength: 1
        maxLength: 25
        enum:
        - box
        - envelope
        - tube
        - pallet
      isActive:
        type: integer
        example: 0
        description: A boolean which indicates whether or not the warehouse can use the container for a particular customer for packaging.
      warehouseId:
        type: integer
        example: 11
        description: 'A unique identifier for a Shipwire or Shipwire Anywhere warehouse. '
      warehouseExternalId:
        type: string
        example: "3"
        description: A unique user-provided identifier for a Shipwire Anywhere warehouse in an external system.
        minLength: 1
        maxLength: 32
      basis:
        type: number
        format: float
        example: 1000.0
        description: Basis is a parameter that is used by Shipwire to prioritize the use of some boxes over the others depending on the product dimensions. The higher the box dimensions are the higher the basis will be. The highest basis for standard boxes is 1025. Pallets have the highest basis where as envelopes have the lowest basis. When setting up a merchant specific box, if you want to use this new box over some of the generic boxes that are bigger in volume, you need to assign a higher basis for the new box to ensure products rate into the box you create.
      serviceSpecificCarrierCode:
        type: string
        example: null
        description: It indicates that this container is used with a particular carrier service (eg. FDX 1D).
      dimensions:
        $ref: '#/definitions/ResourceDimensionValues_dimensions'
    title: Container Information
  AddCarrierRequest:
    type: object
    required:
    - carrierCodes
    properties:
      carrierCodes:
        type: array
        description: A string consisting of carrier code and service level.
        items:
          type: string
          example: ABM PLITE
  RemoveCarrierRequest:
    type: object
    required:
    - carrierCodes
    properties:
      carrierCodes:
        type: array
        description: A string consisting of carrier code and service level.
        items:
          type: string
          example: FDX 1D
  GetCarrierProperties:
    type: object
    properties:
      code:
        type: string
        example: ABM PLITE
        description: A string consisting of carrier code and service level.
      serviceLevelCode:
        type: string
        example: PLITE
        description: This is the service level code associated with the carrier. There are multiple levels for one type of service. Each level has a specific code. (e.g. For FDX the codes are 1D, 2D, GD, etc.)
      name:
        type: string
        example: ABM Parcel Lite Large
        description: Name of the carrier
        minLength: 1
        maxLength: 50
      isFreightCarrier:
        type: integer
        example: 0
        description: A boolean that indicates the carrier is a freight carrier. The value "1" (True) means this carrier supports heavy weight orders or large items.
      isRestrictedCarrier:
        type: integer
        example: 0
        description: A boolean that indicates whether or not the carrier is restricted. The value "1" (True) means this carrier is not available for general use. If required, contact customer care for possible enablement.
      isPostalCarrier:
        type: integer
        example: 0
        description: A boolean that indicates the carrier uses a national government postal service, either for aggregated or for last mile delivery.
      isTerritorySupported:
        type: integer
        example: 0
        description: A boolean that indicates if the carrier supports US territories. (e.g. Puerto Rico, Guam, etc.)
      isPoBoxSupported:
        type: integer
        example: 0
        description: A boolean that indicates if the carrier supports PO box delivery.
      isApoFpoSupported:
        type: integer
        example: 0
        description: A boolean that indicates the carrier supports delivery to military addresses (APO, FPO).
      isPickupRequired:
        type: integer
        example: 0
        description: A boolean that indicates the carrier requires pickup. A "0" (False) value would mean that the carrier supports delivery to doorstep. This feature is related to third party carriers.
      isSignatureRequired:
        type: integer
        example: 0
        description: A boolean that indicates the carrier requires a signature upon delivery of the order.
      isSelfInsured:
        type: integer
        example: 0
        description: A boolean that indicates the carrier is self-insured for damages that occur to an order while in transit.
      isDangerousGoodsSupported:
        type: integer
        example: 0
        description: A boolean that indicates the carrier can transport orders that include dangerous goods. (e.g. chemicals, etc.)
      isTrackable:
        type: integer
        example: 0
        description: A boolean that indicates orders transported by the carrier will receive a tracking ID so that it can be tracked after leaving the warehouse through to delivery.
      isMediaSupported:
        type: integer
        example: 0
        description: A boolean that indicates the carrier provides special services specific to the handling of media. (e.g. books, videotapes, DVDs, CDs, printed music and other sound recordings)
      minimumShippingDays:
        type: integer
        example: 2
        description: The minimum number of days the carrier takes for shipping the order.
      maximumShippingDays:
        type: integer
        example: 5
        description: The maximum number of days the carrier takes for shipping the order.
    title: Carrier Properties
    description: Carrier properties for container
  CostValues:
    type: object
    properties:
      costValue:
        type: string
        example: "1.0"
        description: This is the cost value for the container. During cartonization (choosing packaging) phase for an order, Shipwire will first consider containers with a lower cost, even if chosing one will end up making the shipping cost comparatively higher. E.g. Shipwire will chose a container 1 with a $0 cost over a container 2 with a $1 cost, even if the shipping cost for using an overly large container 1 is $10 higher than for using a container 2.
      retailValue:
        type: string
        example: "2.0"
        description: This is the retail value for the container. Container retail value will be added to the shipping quote for the customer. If a merchant doesn't plan to charge customers for cartons/boxes, the container retail value should be set to $0.
      costValueCurrency:
        type: string
        example: USD
        description: This is the currency used in determining cost value for the container.
      retailValueCurrency:
        type: string
        example: USD
        description: This is the currency used in determining retail value for the container.
    title: Container Cost Values
  ResourceInWarehouseResponse:
    type: object
    properties:
      resourceLocation:
        type: string
        example: https://api.shipwire.com/api/v3.1/containers/268041
        description: A URL that gives more information about the linked resource. A "null" value would mean that no further information is available for that resource
      resource:
        $ref: '#/definitions/ResourceInWarehouseResponse_resource'
    title: Warehouse Response Resource
  GetContainersAssociatedWithAWarehouseResponse_resource:
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/ResourceInWarehouseResponse'
  WarehouseInformation_address:
    properties:
      resourceLocation:
        type: string
        example: null
        description: A URL that gives more information about the linked resource. A "null" value would mean that no further information is available for that resource.
      resource:
        $ref: '#/definitions/WarehouseAddress'
  WarehouseInformation_containers:
    properties:
      resourceLocation:
        type: string
        example: https://api.shipwire.com/api/v3.1/warehouses/11/containers?offset=0&limit=20
        description: A URL that gives more information about the linked resource. A "null" value would mean that no further information is available for that resource.
  GetWarehouseResources_items:
    properties:
      resourceLocation:
        type: string
        example: https://api.shipwire.com/api/v3.1/warehouses/11
        description: A URL that gives more information about the linked resource. A "null" value would mean that no further information is available for that resource.
      resource:
        $ref: '#/definitions/WarehouseInformation'
  ResourceDimensionValues_dimensions:
    properties:
      resourceLocation:
        type: string
        example: null
        description: A URL that gives more information about the linked resource. A "null" value would mean that no further information is available for that resource.
      resource:
        $ref: '#/definitions/ContainerDimensions'
  ResourceInWarehouseResponse_resource_values:
    properties:
      resourceLocation:
        type: string
        example: null
        description: A URL that gives more information about the linked resource. A "null" value would mean that no further information is available for that resource.
      resource:
        $ref: '#/definitions/CostValues'
  ResourceInWarehouseResponse_resource:
    properties:
      values:
        $ref: '#/definitions/ResourceInWarehouseResponse_resource_values'
