Orders Sale Create

orders
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Orders Purchase Partial Update

Request

Security

Bearer

Path

idstringrequired

Bodyapplication/json

typestring(Type)required

Enum"order""produced_batch""manufactured_batch"

buyer_external_idstring or null(Buyer external id)[ 1 .. 255 ] characters

seller_external_idstring or null(Seller external id)[ 1 .. 255 ] characters

order_created_atstring(date)(Order created at)required

order_arrival_atstring or null(date)(Order arrival at)

order_statusstring(Order status)

Enum"draft""open""complete""cancelled"

value_chaininteger or null(Value chain)

value_chain_detailobject(ValueChain)

seller_company_idinteger or null(Seller company id)[ 0 .. 2147483647 ]

companyobject(CoolsetCompany)

buyer_companyobject(CoolsetCompany)

seller_companyobject(CoolsetCompany)

itemsArray of objects(NestedOrderItem)

curl -i -X PATCH \
  'https://api.coolset.com/_mock/supply-chain-api/orders/purchase/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "order",
    "buyer_external_id": "string",
    "seller_external_id": "string",
    "order_created_at": "2019-08-24",
    "order_arrival_at": "2019-08-24",
    "order_status": "draft",
    "value_chain": 0,
    "value_chain_detail": {
      "company_name": "string",
      "description": "string",
      "status": "revoked",
      "country_code": "st",
      "external_id": "string",
      "permission_granted": true,
      "is_self_managed": true,
      "contact_name": "string",
      "contact_email": "user@example.com",
      "invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
      "reciprocal_company_id": 2147483647
    },
    "seller_company_id": 2147483647,
    "company": {},
    "buyer_company": {},
    "seller_company": {},
    "items": [
      {
        "id": 0,
        "buyer_product": 0,
        "buyer_product_detail": {},
        "seller_product": 0,
        "seller_product_detail": {},
        "volume": 0,
        "unit": "str",
        "line_number": 2147483647,
        "external_id": "string"
      }
    ]
  }'

Responses

Bodyapplication/json

idinteger(ID)read-only

typestring(Type)required

Enum"order""produced_batch""manufactured_batch"

buyer_external_idstring or null(Buyer external id)[ 1 .. 255 ] characters

seller_external_idstring or null(Seller external id)[ 1 .. 255 ] characters

order_created_atstring(date)(Order created at)required

order_arrival_atstring or null(date)(Order arrival at)

order_statusstring(Order status)

Enum"draft""open""complete""cancelled"

assessment_statusstring(Assessment status)read-only

Enum"pending""passing""failing"

value_chaininteger or null(Value chain)

value_chain_detailobject(ValueChain)

seller_company_idinteger or null(Seller company id)[ 0 .. 2147483647 ]

companyobject(CoolsetCompany)

buyer_companyobject(CoolsetCompany)

seller_companyobject(CoolsetCompany)

itemsArray of objects(NestedOrderItem)

due_diligence_statementsArray of integersuniqueread-only

assessment_summaryobject(Assessment summary)read-only

created_atstring(date-time)(Created at)read-only

updated_atstring(date-time)(Updated at)read-only

Response

application/json

{
  "id": 0,
  "type": "order",
  "buyer_external_id": "string",
  "seller_external_id": "string",
  "order_created_at": "2019-08-24",
  "order_arrival_at": "2019-08-24",
  "order_status": "draft",
  "assessment_status": "pending",
  "value_chain": 0,
  "value_chain_detail": {
    "id": 0,
    "company_name": "string",
    "description": "string",
    "status": "revoked",
    "assessment_status": "pending",
    "country_code": "st",
    "external_id": "string",
    "permission_granted": true,
    "is_self_managed": true,
    "contact_name": "string",
    "contact_email": "user@example.com",
    "invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
    "reciprocal_company_id": 2147483647,
    "has_account": "string",
    "is_invited": "string",
    "pulse_params": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "assessment_summary": {}
  },
  "seller_company_id": 2147483647,
  "company": {
    "id": 0,
    "name": "string",
    "slug": "string",
    "type": "string",
    "city": "string",
    "country": "string",
    "nr_of_employees": 0,
    "nr_of_locations": 0,
    "default_currency": "string",
    "default_locale": "string",
    "data_room_consumer_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "buyer_company": {
    "id": 0,
    "name": "string",
    "slug": "string",
    "type": "string",
    "city": "string",
    "country": "string",
    "nr_of_employees": 0,
    "nr_of_locations": 0,
    "default_currency": "string",
    "default_locale": "string",
    "data_room_consumer_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "seller_company": {
    "id": 0,
    "name": "string",
    "slug": "string",
    "type": "string",
    "city": "string",
    "country": "string",
    "nr_of_employees": 0,
    "nr_of_locations": 0,
    "default_currency": "string",
    "default_locale": "string",
    "data_room_consumer_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "items": [
    { … }
  ],
  "due_diligence_statements": [
    0
  ],
  "assessment_summary": {},
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}