---
updatedAt: 2026-04-27T07:13:45.000Z
agentTools:
  projectIndex: https://developers.smartrecruiters.com/llms.txt
---

# Orders assessment package for candidate

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Assessment Partner Application",
    "description": "Assessment Partner Application",
    "version": "1.0",
    "contact": {
      "name": "SmartRecruiters",
      "url": "https://developers.smartrecruiters.com"
    }
  },
  "servers": [
    {
      "url": "https://your.domain.com"
    }
  ],
  "paths": {
    "/packages/orders": {
      "post": {
        "tags": [
          "orders"
        ],
        "summary": "Orders assessment package for candidate",
        "operationId": "ordersAssessmentPackage",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssessmentPackageOrderRequest"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Order acceptance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unit"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Request missed required scopes",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "There is no package which was ordered",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "oauth2": [
              "orders_modify"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Unit": {
        "type": "object"
      },
      "Error": {
        "required": [
          "code"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "ErrorResponse": {
        "required": [
          "errors"
        ],
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "AssessmentPackageOrderRequest": {
        "required": [
          "assessmentPackageId",
          "candidate",
          "companyId",
          "jobId",
          "resultCallbackURL",
          "job"
        ],
        "type": "object",
        "properties": {
          "resultCallbackURL": {
            "type": "string",
            "format": "uri"
          },
          "candidate": {
            "$ref": "#/components/schemas/Candidate"
          },
          "job": {
            "$ref": "#/components/schemas/Job"
          },
          "requester": {
            "$ref": "#/components/schemas/OrderRequester"
          },
          "assessmentPackageId": {
            "type": "string"
          },
          "jobId": {
            "type": "string",
            "deprecated": true
          },
          "companyId": {
            "type": "string"
          },
          "fields": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "example": {
              "partner-field-id": "partner-field-value"
            }
          }
        }
      },
      "Candidate": {
        "required": [
          "applicationLanguage",
          "email",
          "firstName",
          "id",
          "lastName"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "applicationLanguage": {
            "type": "string"
          }
        }
      },
      "Job": {
        "required": [
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          }
        }
      },
      "OrderRequester": {
        "required": [
          "email",
          "userId"
        ],
        "type": "object",
        "properties": {
          "userId": {
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://www.partner.com/identity/oauth/token",
            "scopes": {
              "packages_view": "Allows reading list of assessment packages",
              "orders_manage": "Allows creating orders"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```