Farmbrite Warehouses API

openapi: 3.2.0
info:
  title: Farmbrite API Developers Documentation Warehouses API
  description: '# Overview


    Welcome to the Farmbrite API. You can find out more about Farmbrite at

    www.farmbrite.com


    If you need help, check out our help center at help.farmbrite.com or email us at dev@farmbrite.com. ## API Reference


    The Farmbrite API allows authorized users programatic access to their account data in order to facilitate the integration of this data with other systems and service. The API is organized around REST standards. The API uses resource-oriented URLs and returns JSON-encoded responses. It uses standard HTTP response codes, authentication, and verbs. > Base URL


    ```

    https://api.farmbrite.com/v1


    ```


    # Authentication


    Farmbrite offers 2 authentication options for accessing the API both utilizing Personal Access Tokens (PATs) for enabling access to the API. Access Tokens (API Keys) are associated with an individual user in your account and inherit that user''s role and permissions. You can find the Access Token on the user profile page under API Key. When building an integration we recommend setting up a separate API user for the integration and changing the API KEY on a regular basis. Remember to keep your Access Tokens secret; treat them just like passwords! They act on your behalf when interacting with the API, with the same permissions and access as the user has. _Don''t hardcode them into your programs_. Instead, choose to store them as environment variables. ### Bearer Token


    To make a request to the API include the Authorization Bearer header with your request and include your Access Token (API KEY) as the value. Access Token and API KEY are used interchangeably through out the documentation. > Example cURL request authenticating with Bearer Token authentication


    ```

    curl https://api.farmbrite.com/v1/tasks \

    -H "Authorization: Bearer ACCESS_TOKEN"


    ```


    ### API Key


    Alternatively to using the Bearer Token authorization method, you can provide an API KEY as a header with your request. Use the header `api_key` with a value of your Access Token (API KEY). > Example cURL request authenticating with API Key header authentication


    ```

    curl https://api.farmbrite.com/v1/tasks \

    -H "api_key: ACCESS_TOKEN"


    ```


    # Errors


    Sadly, sometimes requests to the API fail. Failures can occur for a wide range of reasons. In all cases, the API should return an HTTP Status Code indicating the nature of the failure. | Code | Meaning | Description |

    | --- | --- | --- |

    | 200 | Success | The request was successful. If applicable the data it will be available in the data field at the top level of the response body. |

    | 400 | Bad Request | Typically caused by a missing or malformed parameter. Check the documentation and your request and try again. |

    | 401 | Unauthorized | No access token or an invalid access token was provided with the request. The error can also occur if the user or account is invalid or does not have access to this resource. |

    | 403 | Forbidden | The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you access resources that the user or account does not have access to. |

    | 404 | Not Found | Either the method and path supplied do not specify a known action or the object related to the request does not exist. |

    | 429 | Too Many Requests | You have exceeded one of the rate limits in the API. See the Rate Limits section for more information. |

    | 500 | Internal Server Error | There was a problem on Farmbrite''s side which was logged and reported to our technical team. You can retry, but if the problem continues please contact support. |


    Details about errors can sometimes also be found in the ''message'' property at the root level of the JSON response body. # Pagination


    In order to optimize performance, all list methods in the API will limit the total response data to a certain number of records and return the data in chunks (pages). API responses will include information about the total records available, the current page and total pages.'
  version: 1.0.0
  x-logo:
    url: https://static.farmbrite.com/assets/www/images/logo.png
    backgroundColor: '#FFFFFF'
    altText: Farmbrite
  termsOfService: https://www.farmbrite.com/terms
  contact:
    name: Farmbrite
    url: https://developers.farmbrite.com
    email: dev@farmbrite.com
servers:
- url: https://api.farmbrite.com/v1
security:
- bearerAuth: []
tags:
- name: Warehouses
  description: A warehouse represents any storage location you want to keep track of inventory. This can be a silo, garage, barn, walk-in cooler, warehouse or other similar storage location.
paths:
  /warehouses:
    post:
      tags:
      - Warehouses
      summary: Create a Warehouse
      description: 'Create a warehouse / storage location


        ### Parameters


        **name** `REQUIRED`


        The name or primary label for your warehouse or storage location


        ---


        **internal_id** `OPTIONAL`


        Custom ID you use to identify this record


        ---


        **track_capabity** `OPTIONAL`


        Boolean value to determine if the warehouse tracks different shelves or bins to store different items OR is treated as a single container like a tank or silo.


        If enabled, retrieving a warehouse will include its current amount available.


        ---


        **capacity** `OPTIONAL`


        If tracking capcity in the warehouse (not bins) - a numeric value to determine the total storage amount available based on unit.


        ---


        **unit** `OPTIONAL`


        If tracking capcity in the warehouse, the unit used for inventory is stored.


        > "Bales", "Barrels", "Bunches", "Bushels", "Dozen", "Fluid Ounces", "Gallons", "Grams", "Head", "Kilograms", "Kiloliter", "Liter", "Milliliter", "Ounces", "Pounds", "Quantity", "Quarts", "Tonnes", "Tons"


        Defaults to `Quantity`


        ---


        **description** `OPTIONAL`


        Text description or summary of the warehouse. Can be used to communicate location or other identification information to your team members.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                description: Alien warehouse
                internal_id: A51
                name: Area 51
                track_capacity: false
                capacity: 0
                unit: null
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: postWarehouses
      x-operation-id-source: derived
    get:
      tags:
      - Warehouses
      summary: List Warehouses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                - id: GUID
                  created_at: '2022-02-06 04:37:36'
                  description: test warehouse
                  internal_id: wh-no1
                  name: Warehouse Numero Uno
                  updated_at: '2022-02-06 04:37:36'
      operationId: getWarehouses
      x-operation-id-source: derived
  /warehouses/{warehouse_id}:
    get:
      tags:
      - Warehouses
      summary: Retrieve a Warehouse
      parameters:
      - name: warehouse_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: GUID
                bins:
                - id: Bin ID
                  capacity: 50
                  created_at: '2020-12-27 00:14:21'
                  description: ''
                  internal_id: chicken-feed
                  name: Chicken Feed
                  unit: quantity
                  updated_at: '2023-08-04 17:15:45'
                capacity: 1000
                created_at: '2020-12-27 00:12:53'
                description: ''
                internal_id: s42
                name: Silo 42
                track_capacity: true
                unit: pounds
                updated_at: '2023-10-24 17:08:00'
                total_qty: 10171
      operationId: getWarehousesByWarehouseId
      x-operation-id-source: derived
    put:
      tags:
      - Warehouses
      summary: Update a Warehouse
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                internal_id: A51
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: warehouse_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: putWarehousesByWarehouseId
      x-operation-id-source: derived
    delete:
      tags:
      - Warehouses
      summary: Delete a Warehouse
      parameters:
      - name: warehouse_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: deleteWarehousesByWarehouseId
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer