PATCH /sales/buy-orders/{buy-order-id}

Update a Buy Order

This endpoint allows you to update a Buy Order.

Operation ID: updateBuyOrder

lock This endpoint requires a Bearer token in the Authorization header.

Path Parameters

Name	Type	Description
`buy-order-id` required path	string	The Buy Order ID

Request Body

Content-Type: application/json

supplier_id integer | null

ID of the supplier associated with the Buy Order. Nullable only if state is 'SAVED_AS_DRAFT'.

warehouse_id integer

ID of the Warehouse associated to the Buy Order.

description string | null

Observations/notes of the Buy Order.

internal_sale_id string | null

Internal ID of the Buy Order.

external_sale_id string | null

External ID of the Buy Order.

related_to_type string | null

Type of object related to the Buy Order. Required with field related_to_id.

FAILURE SCHEDULED_WORK

related_to_id integer | null

ID of the object (failure or scheduled work) related to the Buy Order. Required with field related_to_type.

Responses

data object

Buy Order model structure details

id string read-only

ID of the Buy Order.

type string read-only

Model type

buy_order

attributes object

entity_id integer read-only

type string read-only

Type of Buy Order.

MATERIAL SERVICE

base_total string | null read-only

The total base price of the Buy Order (including discount).

code string read-only

Code of the Buy Order.

completed_at string | null read-only

Date Buy Order is Received (state transition to 'RECEIVED').

Example: 2021-07-21 18:38:00

completed_by integer | null read-only

ID of the user who Received the Buy Order (state transition to 'RECEIVED').

created_by integer | null read-only

ID of the user who created the Buy Order

date_created string | null read-only

Date Buy Order is Created.

Example: 2021-07-21 18:38:00

date_updated string read-only

Date Buy Order was last updated.

Example: 2021-07-21 18:38:00

delivery_address string | null

Delivery Address of the Buy Order.

discount_total string | null read-only

The total discount of the Buy Order.

external_buy_id string | null

External ID of the Buy Order.

internal_buy_id string | null

Internal ID of the Buy Order.

observation string | null

Observations or notes of the Buy Order.

order_id integer read-only

ID of the Buy Order.

processed_at string | null read-only

Date Buy Order is started (state transition to 'CREATED').

Example: 2021-07-21 18:38:00

processed_by integer | null read-only

ID of the user who started the Buy Order (state transition to 'CREATED').

related_to_id integer | null

ID of the object (failure or scheduled work) related to the Buy Order (required with field related_to_type).

related_to_type string | null

Type of object related to the Buy Order (required with field related_to_id).

FAILURE SCHEDULED_WORK

state string

State of the Buy Order.

SAVED_AS_DRAFT CREATED RECEIVED_PARTIALLY RECEIVED CONFIRMED

Example: SAVED_AS_DRAFT

supplier_id integer | null

ID of the Supplier associated to the Buy Order. Required for type 'SERVICE' and state is not 'SAVED_AS_DRAFT'.

total_price number read-only

The total price of the Sell Order (including VAT and discount)

vat_total string | null read-only

The total VAT of the Buy Order.

warehouse_id integer | null

ID of the Warehouse associated to the Buy Order. Required for type 'MATERIAL' and state is not 'SAVED_AS_DRAFT'.

meta object

custom_fields object | null

meta object

Meta model structure details

cost_centers array<string>

Example: ["Cost center","Cost center 2"]

status string

error

error object

properties object

Only present when related to property validation error

dev_message string

Example: Property validation error. Check the "properties" section in the response.

http_code integer

400

message string

Example: Property validation error.

more_info string

status string

error

error object

http_code integer

401

message string

Example: Authentication token invalid.

more_info string

status string

error

error object

http_code integer

403

message string

Example: Action unauthorized

more_info string

status string

error

error object

http_code integer

404

message string

Example: Resource not found

more_info string | null

status string

error

error object

http_code integer

429

message string

Example: Too Many Requests.

more_info string

status string

error

error object

http_code integer

500

message string

Example: An error has occurred during the request.

more_info string

play_circle Try It

Environment

Authorization

Bearer

Path Parameters

buy-order-id

Request Body

PATCH https://api.sandbox.infraspeak.com/v3/sales/buy-orders/{buy-order-id}

curl -X PATCH \
  'https://api.sandbox.infraspeak.com/v3/sales/buy-orders/{buy-order-id}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -d '{
    "supplier_id": 0,
    "warehouse_id": 0,
    "description": "",
    "internal_sale_id": "",
    "external_sale_id": "",
    "related_to_type": "",
    "related_to_id": 0
}'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/sales/buy-orders/{buy-order-id}', {
  method: 'PATCH',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
  body: JSON.stringify({
    "supplier_id": 0,
    "warehouse_id": 0,
    "description": "",
    "internal_sale_id": "",
    "external_sale_id": "",
    "related_to_type": "",
    "related_to_id": 0
}),
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->patch('https://api.sandbox.infraspeak.com/v3/sales/buy-orders/{buy-order-id}',
    array (
      'supplier_id' => 0,
      'warehouse_id' => 0,
      'description' => '',
      'internal_sale_id' => '',
      'external_sale_id' => '',
      'related_to_type' => '',
      'related_to_id' => 0,
    )
  );

import requests

response = requests.patch(
    'https://api.sandbox.infraspeak.com/v3/sales/buy-orders/{buy-order-id}',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
    json={
        {
            "supplier_id": 0,
            "warehouse_id": 0,
            "description": "",
            "internal_sale_id": "",
            "external_sale_id": "",
            "related_to_type": "",
            "related_to_id": 0
        }
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "string",
        "type": "buy_order",
        "attributes": {
            "entity_id": 0,
            "type": "MATERIAL",
            "base_total": "string",
            "code": "string",
            "completed_at": "2021-07-21 18:38:00",
            "completed_by": 0,
            "created_by": 0,
            "date_created": "2021-07-21 18:38:00",
            "date_updated": "2021-07-21 18:38:00",
            "delivery_address": "string",
            "discount_total": "string",
            "external_buy_id": "string",
            "internal_buy_id": "string",
            "observation": "string",
            "order_id": 0,
            "processed_at": "2021-07-21 18:38:00",
            "processed_by": 0,
            "related_to_id": 0,
            "related_to_type": "FAILURE",
            "state": "SAVED_AS_DRAFT",
            "supplier_id": 0,
            "total_price": 0,
            "vat_total": "string",
            "warehouse_id": 0
        },
        "meta": {
            "custom_fields": {}
        }
    },
    "meta": {
        "cost_centers": [
            "Cost center",
            "Cost center 2"
        ]
    }
}

400 Bad Request. Occurs when invalid parameters are provided or on data validation errors. For example, trying to create a resource without providing required fields. In this case, you can check the `properties` attribute on the response for more details.

{
    "status": "error",
    "error": {
        "properties": {},
        "dev_message": "Property validation error. Check the \"properties\" section in the response.",
        "http_code": 400,
        "message": "Property validation error.",
        "more_info": "string"
    }
}

401 Unauthorized. Authentication or permission error. E.g.: missing, incorrect or invalid Access Token.

{
    "status": "error",
    "error": {
        "http_code": 401,
        "message": "Authentication token invalid.",
        "more_info": "string"
    }
}

403 Forbidden. The action can not be fulfilled.

{
    "status": "error",
    "error": {
        "http_code": 403,
        "message": "Action unauthorized",
        "more_info": "string"
    }
}

404 Resource Not Found. Requests to resources that don't exist or are malformed.

{
    "status": "error",
    "error": {
        "http_code": 404,
        "message": "Resource not found",
        "more_info": "string"
    }
}

429 Too Many Requests. The client has sent too many requests in a given amount of time (check Throttling section).

{
    "status": "error",
    "error": {
        "http_code": 429,
        "message": "Too Many Requests.",
        "more_info": "string"
    }
}

500 Internal Server Error. Please, report us and try to provide as much information as possible, such as the endpoint, HTTP request headers and request body if applicable.

{
    "status": "error",
    "error": {
        "http_code": 500,
        "message": "An error has occurred during the request.",
        "more_info": "string"
    }
}