---
updatedAt: 2026-04-21T06:16:37.000Z
agentTools:
  projectIndex: https://b2brouter.readme.io/llms.txt
---

# Get an order

Returns information about a specific order.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "B2Brouter API",
    "description": "The B2Brouter API allows you to send and receive electronic documents.",
    "version": "2026-06-26",
    "contact": {
      "name": "Service Delivery Team",
      "email": "servicedelivery@b2brouter.net"
    }
  },
  "servers": [
    {
      "url": "https://api-staging.b2brouter.net",
      "description": "Test server"
    },
    {
      "url": "https://api.b2brouter.net",
      "description": "Production server"
    }
  ],
  "tags": [
    {
      "name": "Orders",
      "description": "Related to orders"
    }
  ],
  "paths": {
    "/orders/{id}.{format}": {
      "get": {
        "operationId": "get-order",
        "tags": [
          "Orders"
        ],
        "summary": "Get an order",
        "description": "Returns information about a specific order.",
        "parameters": [
          {
            "$ref": "#/components/parameters/api_version_header"
          },
          {
            "$ref": "#/components/parameters/order_id"
          },
          {
            "$ref": "#/components/parameters/order_format"
          },
          {
            "$ref": "#/components/parameters/include"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Order"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Order not found"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "description": "API Key of your account",
        "name": "X-B2B-API-Key",
        "in": "header"
      }
    },
    "parameters": {
      "api_version_header": {
        "name": "X-B2B-API-Version",
        "in": "header",
        "description": "Specifies the version of the API to use in this request. If not specified uses the API-Version set in the group conifguration\nB2Brouter UI Application -> Developers -> API Keys -> API Version\n",
        "required": false,
        "schema": {
          "type": "string",
          "example": "2026-06-26",
          "default": "2026-06-26"
        }
      },
      "include": {
        "name": "include",
        "in": "query",
        "description": "Comma-separated list of additional fields to include in the response. Available fields: `lines`, `detailed_lines`, `apply_to_local_government_unit`, `apply_to_vat_group_member`, `third_party`.",
        "schema": {
          "type": "string"
        },
        "example": "detailed_lines"
      },
      "order_id": {
        "name": "id",
        "in": "path",
        "description": "A unique internal identifier of the **Order** in B2Brouter.",
        "required": true,
        "example": 4053100,
        "schema": {
          "$ref": "#/components/schemas/OrderId"
        }
      },
      "order_format": {
        "name": "format",
        "description": "Format of the order",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "enum": [
            "json",
            "original"
          ],
          "description": "In addition to the standard json format, there are some extra visualization formats for an order:\n * `json` - JSON format\n * `original` - Original format\n",
          "example": "json"
        }
      }
    },
    "schemas": {
      "OrderId": {
        "type": "integer",
        "example": 4053100,
        "title": "Order ID",
        "description": "Unique identifier of the **Order** in B2Brouter.",
        "readOnly": true
      },
      "OrderLine": {
        "type": "object",
        "description": "A group of business terms providing information on individual Order lines.",
        "properties": {
          "position": {
            "type": "integer",
            "example": 1,
            "description": "position",
            "writeOnly": true
          },
          "name": {
            "type": "string",
            "example": "Item name",
            "description": "Item name.",
            "maxLength": 65535
          },
          "description": {
            "type": "string",
            "example": "Item description",
            "description": "Item description.",
            "maxLength": 65535
          },
          "quantity": {
            "type": "number",
            "format": "decimal",
            "example": 1,
            "description": "Item quantity.",
            "maxLength": 255
          },
          "unit_code": {
            "type": "string",
            "description": "Item quantity unit code.",
            "maxLength": 65535,
            "example": "1"
          },
          "price": {
            "type": "number",
            "format": "decimal",
            "example": 33.3,
            "description": "The price of an item, exclusive of VAT,after subtracting item price discount.",
            "maxLength": 255
          },
          "total_cost": {
            "type": "number",
            "format": "decimal",
            "example": 33.3,
            "description": "Price * Quantity",
            "maxLength": 255,
            "readOnly": true
          },
          "sellers_item_id": {
            "type": "string",
            "example": "BB12KG",
            "description": "Sellers item identifier.",
            "maxLength": 255
          },
          "additional_item_properties": {
            "type": "object",
            "description": "Additional item properties.",
            "readOnly": true
          },
          "standard_item_identification": {
            "type": "string",
            "description": "Standard item identification.",
            "maxLength": 255,
            "example": "Item identification"
          },
          "item_document_reference": {
            "type": "string",
            "description": "Item document reference.",
            "maxLength": 255,
            "example": "Item reference"
          },
          "delivery_date_start": {
            "type": "string",
            "format": "date",
            "example": "2020-11-01",
            "description": "Order line delivery start date.",
            "maxLength": 255
          },
          "delivery_date_end": {
            "type": "string",
            "format": "date",
            "example": "2020-11-20",
            "description": "Order line delivery end date.",
            "maxLength": 255
          },
          "note": {
            "type": "string",
            "example": "Note",
            "description": "A note for an order line.",
            "maxLength": 255
          }
        }
      },
      "Order": {
        "type": "object",
        "description": "Represents an order as an object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/OrderId"
          },
          "account": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "example": 742,
                "description": "Account ID"
              },
              "name": {
                "type": "string",
                "example": "B2Brouter Global, S.L.",
                "description": "Account Name"
              }
            },
            "readOnly": true
          },
          "company": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "example": 326116,
                "description": "Company ID"
              },
              "name": {
                "type": "string",
                "example": "John Doe",
                "description": "Name of the client or provider"
              },
              "tin_value": {
                "type": "string",
                "description": "VAT identifier\nID: `BT-48`\n",
                "example": "ESA13585625"
              },
              "tin_scheme": {
                "type": "string",
                "description": "The scheme identifier of VAT Number\nYou can get all schemes codes using the **Schemes* endpoint in Code lists section (`/schemes`).\n",
                "example": "9920"
              }
            },
            "readOnly": true
          },
          "contact": {
            "type": "object",
            "description": "Represents a contact as an object",
            "properties": {
              "id": {
                "type": "integer",
                "example": 326116,
                "description": "Contact ID"
              },
              "name": {
                "type": "string",
                "example": "John Doe",
                "description": "Name of the client or provider"
              },
              "tin_value": {
                "type": "string",
                "description": "VAT identifier\nID: `BT-48`\n",
                "example": "ESA13585625"
              },
              "tin_scheme": {
                "type": "string",
                "description": "The scheme identifier of VAT Number\nYou can get all schemes codes using the **Schemes* endpoint in Code lists section (`/schemes`).\n",
                "example": "9920"
              },
              "address": {
                "type": "string",
                "description": "Address",
                "maxLength": 255,
                "nullable": true,
                "example": "Carrer de Sant Antoni, 12"
              },
              "address2": {
                "type": "string",
                "description": "Address 2",
                "maxLength": 255,
                "nullable": true,
                "example": "Carrer de Sant Antoni, 13"
              },
              "postalcode": {
                "type": "string",
                "example": "80808",
                "description": "Postcode",
                "maxLength": 255,
                "nullable": true
              },
              "city": {
                "type": "string",
                "example": "Barcelona",
                "description": "City",
                "maxLength": 255,
                "nullable": true
              },
              "province": {
                "type": "string",
                "example": "Barcelona",
                "description": "Region/Province/County",
                "maxLength": 255,
                "nullable": true
              },
              "country": {
                "type": "string",
                "example": "es",
                "description": "Country",
                "maxLength": 255
              }
            },
            "readOnly": true
          },
          "accounting_party": {
            "type": "object",
            "description": "Represents an accounting party as an object",
            "properties": {
              "id": {
                "type": "integer",
                "example": 326116,
                "description": "Contact ID"
              },
              "name": {
                "type": "string",
                "example": "John Doe",
                "description": "Name of the client or provider"
              },
              "tin_value": {
                "type": "string",
                "description": "VAT identifier\nID: `BT-48`\n",
                "example": "ESA13585625"
              },
              "tin_scheme": {
                "type": "string",
                "description": "The scheme identifier of VAT Number\nYou can get all schemes codes using the **Schemes* endpoint in Code lists section (`/schemes`).\n",
                "example": "9920"
              },
              "address": {
                "type": "string",
                "description": "Address",
                "maxLength": 255,
                "nullable": true,
                "example": "Carrer de Sant Antoni, 14"
              },
              "address2": {
                "type": "string",
                "description": "Address 2",
                "maxLength": 255,
                "nullable": true,
                "example": "Carrer de Sant Antoni, 15"
              },
              "postalcode": {
                "type": "string",
                "example": "80808",
                "description": "Postcode",
                "maxLength": 255
              },
              "city": {
                "type": "string",
                "example": "Barcelona",
                "description": "City",
                "maxLength": 255,
                "nullable": true
              },
              "province": {
                "type": "string",
                "example": "Barcelona",
                "description": "Region/Province/County",
                "maxLength": 255,
                "nullable": true
              },
              "country": {
                "type": "string",
                "example": "es",
                "description": "Country",
                "maxLength": 255
              }
            },
            "readOnly": true
          },
          "number": {
            "type": "string",
            "example": "3",
            "description": "A unique identification of the Order.\n",
            "maxLength": 100
          },
          "issue_datetime": {
            "type": "string",
            "format": "datetime",
            "description": "A datetime when the order was issued.",
            "example": "2020-07-06T09:36:18Z",
            "readOnly": true
          },
          "currency": {
            "type": "string",
            "example": "EUR",
            "description": "The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency.",
            "maxLength": 3,
            "nullable": true
          },
          "validity_start": {
            "type": "string",
            "format": "date",
            "description": "Validity start",
            "example": "2020-11-01",
            "nullable": true
          },
          "validity_end": {
            "type": "string",
            "format": "date",
            "description": "Validity end",
            "example": "2020-12-01",
            "nullable": true
          },
          "contract": {
            "type": "string",
            "example": "Contract",
            "description": "Contract",
            "maxLength": 255,
            "nullable": true
          },
          "type_code": {
            "type": "string",
            "example": "Type code",
            "description": "Type code",
            "maxLength": 255,
            "nullable": true
          },
          "state": {
            "type": "string",
            "description": "State of order",
            "example": "received",
            "maxLength": 255
          },
          "is_confirmation": {
            "type": "boolean",
            "default": false,
            "example": true,
            "enum": [
              true,
              false
            ],
            "description": "Is confirmation"
          },
          "anticipated_amount_in_cents": {
            "type": "integer",
            "example": 3330,
            "description": "Anticipated amount in cents.",
            "readOnly": true
          },
          "invoice_id": {
            "type": "integer",
            "example": 4053100,
            "description": "A unique internal identifier of the Invoice in B2Brouter.",
            "readOnly": true,
            "nullable": true
          },
          "delivery_date_start": {
            "type": "string",
            "format": "date",
            "description": "Delivery date start",
            "example": "2020-11-01",
            "nullable": true
          },
          "delivery_date_end": {
            "type": "string",
            "format": "date",
            "description": "Delivery date end",
            "example": "2020-11-12",
            "nullable": true
          },
          "delivery_address": {
            "type": "string",
            "example": "Address 1",
            "description": "Delivery address 1",
            "maxLength": 255,
            "nullable": true
          },
          "delivery_address2": {
            "type": "string",
            "example": "Address 2",
            "description": "Delivery address 2",
            "maxLength": 255,
            "nullable": true
          },
          "delivery_address3": {
            "type": "string",
            "example": "Address 3",
            "description": "Delivery address 3",
            "maxLength": 255,
            "nullable": true
          },
          "delivery_city": {
            "type": "string",
            "example": "Barcelona",
            "description": "Delivery city",
            "maxLength": 255,
            "nullable": true
          },
          "delivery_postalcode": {
            "type": "string",
            "example": "80808",
            "description": "Delivery postal code",
            "maxLength": 255,
            "nullable": true
          },
          "delivery_province": {
            "type": "string",
            "example": "Barcelona",
            "description": "Region/Province/County",
            "maxLength": 255,
            "nullable": true
          },
          "delivery_country": {
            "type": "string",
            "example": "es",
            "description": "Delivery country",
            "maxLength": 255,
            "nullable": true
          },
          "delivery_party_id": {
            "type": "string",
            "example": "111",
            "description": "Delivery party id",
            "maxLength": 255,
            "nullable": true
          },
          "delivery_party_scheme": {
            "type": "string",
            "example": "9920",
            "description": "Delivery party scheme",
            "maxLength": 255,
            "nullable": true
          },
          "delivery_party_name": {
            "type": "string",
            "example": "Delivery party name",
            "description": "Delivery party name",
            "maxLength": 255,
            "nullable": true
          },
          "delivery_location_id": {
            "type": "string",
            "example": "111",
            "description": "Delivery location id",
            "maxLength": 255,
            "nullable": true
          },
          "delivery_location_name": {
            "type": "string",
            "example": "Delivery party name",
            "description": "Delivery location name",
            "maxLength": 255,
            "nullable": true
          },
          "originator_id": {
            "type": "string",
            "example": "111",
            "description": "Originator id",
            "maxLength": 255,
            "nullable": true
          },
          "originator_name": {
            "type": "string",
            "example": "Originator name",
            "description": "Originator name",
            "maxLength": 255,
            "nullable": true
          },
          "buyer_contact_name": {
            "type": "string",
            "example": "Buyer contac name",
            "description": "Buyer contac name",
            "maxLength": 255,
            "nullable": true
          },
          "buyer_contact_phone": {
            "type": "string",
            "example": "6666666666",
            "description": "Phone",
            "maxLength": 255,
            "nullable": true
          },
          "buyer_contact_email": {
            "type": "string",
            "example": "john.doe@example.com",
            "description": "Email",
            "maxLength": 255,
            "nullable": true
          },
          "notes": {
            "type": "string",
            "example": "Notes",
            "nullable": true
          },
          "order_format": {
            "type": "string",
            "example": "ubl",
            "nullable": true
          },
          "additional_document_references": {
            "type": "object",
            "description": "Additional Order references.",
            "readOnly": true,
            "nullable": true
          },
          "order_lines": {
            "type": "array",
            "description": "A group of business terms providing information on individual order lines.\n",
            "items": {
              "$ref": "#/components/schemas/OrderLine"
            },
            "readOnly": true
          },
          "attachments": {
            "type": "array",
            "description": "A group of business terms providing information on attachments.\n",
            "items": {
              "type": "object",
              "properties": {
                "link": {
                  "type": "string",
                  "example": "/attachments/download/1/order.xml"
                },
                "content_type": {
                  "type": "string",
                  "example": "text/xml"
                }
              }
            },
            "readOnly": true
          },
          "created_at": {
            "type": "string",
            "format": "datetime",
            "description": "A datetime when the object was created in B2Brouter.",
            "example": "2020-07-06T09:36:18Z",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "datetime",
            "description": "A datetime of the last time the invoice was updated.",
            "example": "2020-07-06T09:36:18Z",
            "readOnly": true
          }
        }
      }
    }
  }
}
```