# Orders List

Endpoint: GET /orders
Version: 1.0
Security: Bearer

## Query parameters:

  - `type` (string)
    type
    Enum: "order", "produced_batch", "manufactured_batch"

  - `type__in` (string)
    type__in

  - `order_created_at` (string)
    order_created_at

  - `order_created_at__gte` (string)
    order_created_at__gte

  - `order_created_at__lte` (string)
    order_created_at__lte

  - `order_arrival_at` (string)
    order_arrival_at

  - `order_arrival_at__gte` (string)
    order_arrival_at__gte

  - `order_arrival_at__lte` (string)
    order_arrival_at__lte

  - `order_status` (string)
    order_status
    Enum: "draft", "open", "complete", "cancelled"

  - `order_status__in` (string)
    order_status__in

  - `assessment_status` (string)
    assessment_status
    Enum: "pending", "passing", "failing"

  - `assessment_status__in` (string)
    assessment_status__in

  - `value_chain` (string)
    value_chain

  - `items__buyer_product` (string)
    items__buyer_product

  - `items__buyer_product__in` (string)
    items__buyer_product__in

  - `items__buyer_product__isnull` (string)
    items__buyer_product__isnull

  - `items__seller_product` (string)
    items__seller_product

  - `items__seller_product__in` (string)
    items__seller_product__in

  - `items__seller_product__isnull` (string)
    items__seller_product__isnull

  - `items__volume` (string)
    items__volume

  - `items__volume__gte` (string)
    items__volume__gte

  - `items__volume__lte` (string)
    items__volume__lte

  - `items__unit` (string)
    items__unit

  - `items__external_id` (string)
    items__external_id

  - `items__external_id__icontains` (string)
    items__external_id__icontains

  - `items__external_id__startswith` (string)
    items__external_id__startswith

  - `items__external_id__endswith` (string)
    items__external_id__endswith

  - `items__external_id__in` (string)
    items__external_id__in

  - `items__buyer_product__sku` (string)
    items__buyer_product__sku

  - `items__buyer_product__sku__icontains` (string)
    items__buyer_product__sku__icontains

  - `items__buyer_product__sku__startswith` (string)
    items__buyer_product__sku__startswith

  - `items__buyer_product__sku__endswith` (string)
    items__buyer_product__sku__endswith

  - `items__buyer_product__name` (string)
    items__buyer_product__name

  - `items__buyer_product__name__icontains` (string)
    items__buyer_product__name__icontains

  - `items__buyer_product__name__startswith` (string)
    items__buyer_product__name__startswith

  - `items__buyer_product__name__endswith` (string)
    items__buyer_product__name__endswith

  - `items__buyer_product__commodity` (string)
    items__buyer_product__commodity
    Enum: "cattle", "cocoa", "coffee", "palm_oil", "rubber", "soya", "wood"

  - `items__buyer_product__commodity__in` (string)
    items__buyer_product__commodity__in

  - `items__buyer_product__composition` (string)
    items__buyer_product__composition
    Enum: "simple", "composite"

  - `items__buyer_product__composition__in` (string)
    items__buyer_product__composition__in

  - `items__seller_product__sku` (string)
    items__seller_product__sku

  - `items__seller_product__sku__icontains` (string)
    items__seller_product__sku__icontains

  - `items__seller_product__sku__startswith` (string)
    items__seller_product__sku__startswith

  - `items__seller_product__sku__endswith` (string)
    items__seller_product__sku__endswith

  - `items__seller_product__name` (string)
    items__seller_product__name

  - `items__seller_product__name__icontains` (string)
    items__seller_product__name__icontains

  - `items__seller_product__name__startswith` (string)
    items__seller_product__name__startswith

  - `items__seller_product__name__endswith` (string)
    items__seller_product__name__endswith

  - `items__seller_product__commodity` (string)
    items__seller_product__commodity
    Enum: "cattle", "cocoa", "coffee", "palm_oil", "rubber", "soya", "wood"

  - `items__seller_product__commodity__in` (string)
    items__seller_product__commodity__in

  - `items__seller_product__composition` (string)
    items__seller_product__composition
    Enum: "simple", "composite"

  - `items__seller_product__composition__in` (string)
    items__seller_product__composition__in

  - `passing_percentage_gte` (string)
    passing_percentage_gte

  - `failing_percentage_gte` (string)
    failing_percentage_gte

  - `order_action` (string, required)
    order_action
    Enum: "buying", "selling"

  - `ordering` (string)
    Which field to use when ordering the results.

  - `search` (string)
    A search term.

  - `limit` (integer)
    Number of results to return per page.

  - `offset` (integer)
    The initial index from which to return the results.

## Response 200 fields (application/json):

  - `count` (integer, required)

  - `next` (string,null)

  - `previous` (string,null)

  - `results` (array, required)

  - `results.id` (integer)

  - `results.company_id` (integer, required)

  - `results.type` (string, required)
    Enum: "order", "produced_batch", "manufactured_batch"

  - `results.buyer_external_id` (string,null)

  - `results.seller_external_id` (string,null)

  - `results.order_created_at` (string, required)

  - `results.order_arrival_at` (string,null)

  - `results.order_status` (string)
    Enum: "draft", "open", "complete", "cancelled"

  - `results.assessment_status` (string)
    Enum: "pending", "passing", "failing"

  - `results.value_chain` (integer,null)

  - `results.value_chain_detail` (object)

  - `results.value_chain_detail.company_name` (string, required)

  - `results.value_chain_detail.description` (string,null)

  - `results.value_chain_detail.status` (string)
    Enum: "revoked", "not_invited_yet", "invitation_sent", "connected"

  - `results.value_chain_detail.country_code` (string, required)

  - `results.value_chain_detail.external_id` (string,null)

  - `results.value_chain_detail.permission_granted` (boolean)

  - `results.value_chain_detail.is_self_managed` (boolean)

  - `results.value_chain_detail.contact_name` (string, required)

  - `results.value_chain_detail.contact_email` (string, required)

  - `results.value_chain_detail.invitation_id` (string,null)

  - `results.value_chain_detail.reciprocal_company_id` (integer,null)

  - `results.value_chain_detail.has_account` (string)

  - `results.value_chain_detail.is_invited` (string)

  - `results.value_chain_detail.pulse_params` (string)

  - `results.value_chain_detail.created_at` (string)

  - `results.value_chain_detail.updated_at` (string)

  - `results.value_chain_detail.assessment_summary` (object)

  - `results.buyer_company_id` (integer,null)

  - `results.seller_company_id` (integer,null)

  - `results.company` (object)

  - `results.company.name` (string)

  - `results.company.slug` (string,null)

  - `results.company.city` (string,null)

  - `results.company.country` (string,null)

  - `results.company.nr_of_employees` (integer,null)

  - `results.company.nr_of_locations` (integer,null)

  - `results.company.default_currency` (string)

  - `results.company.default_locale` (string)

  - `results.company.data_room_consumer_id` (string,null)

  - `results.buyer_company` (object)

  - `results.seller_company` (object)

  - `results.items` (array)

  - `results.items.order` (integer)

  - `results.items.buyer_product` (integer,null)

  - `results.items.buyer_product_detail` (object)

  - `results.items.buyer_product_detail.sku` (string)

  - `results.items.buyer_product_detail.scientific_name` (string,null)

  - `results.items.buyer_product_detail.common_name` (string,null)

  - `results.items.buyer_product_detail.hs_code` (string)

  - `results.items.buyer_product_detail.commodity` (string)
    Enum: "cattle", "cocoa", "coffee", "palm_oil", "rubber", "soya", "wood"

  - `results.items.buyer_product_detail.composition` (string)
    Enum: "simple", "composite"

  - `results.items.seller_product` (integer,null)

  - `results.items.seller_product_detail` (object)

  - `results.items.volume` (number, required)

  - `results.items.unit` (string, required)

  - `results.items.line_number` (integer,null)

  - `results.items.is_complete_match` (string)

  - `results.items.traced_order_count` (string)

  - `results.items.traced_origin_count` (string)

  - `results.due_diligence_statements` (array)

  - `results.due_diligence_statements.dds_data` (object)