Partial update order

curl --request PATCH \
  --url https://api.piriod.com/orders/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-simple-workspace: <x-simple-workspace>' \
  --data '
{
  "customer": "<string>",
  "document": 123,
  "date": "2023-12-25",
  "lines": [
    {
      "name": "<string>",
      "amount": 123,
      "quantity": 123,
      "description": "<string>",
      "exempt": false,
      "tax": 123,
      "tax_percent": 123
    }
  ],
  "number": 123,
  "address": "<string>",
  "state": 123,
  "carrier_id": "<string>",
  "carrier_name": "<string>",
  "licence_plate": "<string>",
  "note": "<string>",
  "amount": 123,
  "exempt": 123,
  "tax": 123,
  "tax_percent": 123,
  "total": 123,
  "references": [
    {
      "date": "2023-12-25",
      "document": "<string>",
      "serial": "<string>",
      "description": "<string>"
    }
  ]
}
'

import requests

url = "https://api.piriod.com/orders/{id}/"

payload = {
    "customer": "<string>",
    "document": 123,
    "date": "2023-12-25",
    "lines": [
        {
            "name": "<string>",
            "amount": 123,
            "quantity": 123,
            "description": "<string>",
            "exempt": False,
            "tax": 123,
            "tax_percent": 123
        }
    ],
    "number": 123,
    "address": "<string>",
    "state": 123,
    "carrier_id": "<string>",
    "carrier_name": "<string>",
    "licence_plate": "<string>",
    "note": "<string>",
    "amount": 123,
    "exempt": 123,
    "tax": 123,
    "tax_percent": 123,
    "total": 123,
    "references": [
        {
            "date": "2023-12-25",
            "document": "<string>",
            "serial": "<string>",
            "description": "<string>"
        }
    ]
}
headers = {
    "x-simple-workspace": "<x-simple-workspace>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-simple-workspace': '<x-simple-workspace>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customer: '<string>',
    document: 123,
    date: '2023-12-25',
    lines: [
      {
        name: '<string>',
        amount: 123,
        quantity: 123,
        description: '<string>',
        exempt: false,
        tax: 123,
        tax_percent: 123
      }
    ],
    number: 123,
    address: '<string>',
    state: 123,
    carrier_id: '<string>',
    carrier_name: '<string>',
    licence_plate: '<string>',
    note: '<string>',
    amount: 123,
    exempt: 123,
    tax: 123,
    tax_percent: 123,
    total: 123,
    references: [
      {
        date: '2023-12-25',
        document: '<string>',
        serial: '<string>',
        description: '<string>'
      }
    ]
  })
};

fetch('https://api.piriod.com/orders/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.piriod.com/orders/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => '<string>',
    'document' => 123,
    'date' => '2023-12-25',
    'lines' => [
        [
                'name' => '<string>',
                'amount' => 123,
                'quantity' => 123,
                'description' => '<string>',
                'exempt' => false,
                'tax' => 123,
                'tax_percent' => 123
        ]
    ],
    'number' => 123,
    'address' => '<string>',
    'state' => 123,
    'carrier_id' => '<string>',
    'carrier_name' => '<string>',
    'licence_plate' => '<string>',
    'note' => '<string>',
    'amount' => 123,
    'exempt' => 123,
    'tax' => 123,
    'tax_percent' => 123,
    'total' => 123,
    'references' => [
        [
                'date' => '2023-12-25',
                'document' => '<string>',
                'serial' => '<string>',
                'description' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "x-simple-workspace: <x-simple-workspace>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.piriod.com/orders/{id}/"

	payload := strings.NewReader("{\n  \"customer\": \"<string>\",\n  \"document\": 123,\n  \"date\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"name\": \"<string>\",\n      \"amount\": 123,\n      \"quantity\": 123,\n      \"description\": \"<string>\",\n      \"exempt\": false,\n      \"tax\": 123,\n      \"tax_percent\": 123\n    }\n  ],\n  \"number\": 123,\n  \"address\": \"<string>\",\n  \"state\": 123,\n  \"carrier_id\": \"<string>\",\n  \"carrier_name\": \"<string>\",\n  \"licence_plate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"amount\": 123,\n  \"exempt\": 123,\n  \"tax\": 123,\n  \"tax_percent\": 123,\n  \"total\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-simple-workspace", "<x-simple-workspace>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.piriod.com/orders/{id}/")
  .header("x-simple-workspace", "<x-simple-workspace>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": \"<string>\",\n  \"document\": 123,\n  \"date\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"name\": \"<string>\",\n      \"amount\": 123,\n      \"quantity\": 123,\n      \"description\": \"<string>\",\n      \"exempt\": false,\n      \"tax\": 123,\n      \"tax_percent\": 123\n    }\n  ],\n  \"number\": 123,\n  \"address\": \"<string>\",\n  \"state\": 123,\n  \"carrier_id\": \"<string>\",\n  \"carrier_name\": \"<string>\",\n  \"licence_plate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"amount\": 123,\n  \"exempt\": 123,\n  \"tax\": 123,\n  \"tax_percent\": 123,\n  \"total\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.piriod.com/orders/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer\": \"<string>\",\n  \"document\": 123,\n  \"date\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"name\": \"<string>\",\n      \"amount\": 123,\n      \"quantity\": 123,\n      \"description\": \"<string>\",\n      \"exempt\": false,\n      \"tax\": 123,\n      \"tax_percent\": 123\n    }\n  ],\n  \"number\": 123,\n  \"address\": \"<string>\",\n  \"state\": 123,\n  \"carrier_id\": \"<string>\",\n  \"carrier_name\": \"<string>\",\n  \"licence_plate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"amount\": 123,\n  \"exempt\": 123,\n  \"tax\": 123,\n  \"tax_percent\": 123,\n  \"total\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "customer": "<string>",
  "document": 123,
  "date": "2023-12-25",
  "lines": [
    {
      "name": "<string>",
      "amount": 123,
      "quantity": 123,
      "id": 123,
      "description": "<string>",
      "exempt": false,
      "tax": 123,
      "tax_percent": 123,
      "total": 123
    }
  ],
  "id": 123,
  "number": 123,
  "address": "<string>",
  "state": 123,
  "carrier_id": "<string>",
  "carrier_name": "<string>",
  "licence_plate": "<string>",
  "note": "<string>",
  "amount": 123,
  "exempt": 123,
  "tax": 123,
  "tax_percent": 123,
  "total": 123,
  "status": "draft",
  "biller_status": "<string>",
  "tax_agency": {},
  "local_file": "<string>",
  "imported": true,
  "test_mode": true,
  "references": [
    {
      "date": "2023-12-25",
      "document": "<string>",
      "serial": "<string>",
      "description": "<string>"
    }
  ],
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

PATCH

orders

{id}

Partial update order

curl --request PATCH \
  --url https://api.piriod.com/orders/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-simple-workspace: <x-simple-workspace>' \
  --data '
{
  "customer": "<string>",
  "document": 123,
  "date": "2023-12-25",
  "lines": [
    {
      "name": "<string>",
      "amount": 123,
      "quantity": 123,
      "description": "<string>",
      "exempt": false,
      "tax": 123,
      "tax_percent": 123
    }
  ],
  "number": 123,
  "address": "<string>",
  "state": 123,
  "carrier_id": "<string>",
  "carrier_name": "<string>",
  "licence_plate": "<string>",
  "note": "<string>",
  "amount": 123,
  "exempt": 123,
  "tax": 123,
  "tax_percent": 123,
  "total": 123,
  "references": [
    {
      "date": "2023-12-25",
      "document": "<string>",
      "serial": "<string>",
      "description": "<string>"
    }
  ]
}
'

import requests

url = "https://api.piriod.com/orders/{id}/"

payload = {
    "customer": "<string>",
    "document": 123,
    "date": "2023-12-25",
    "lines": [
        {
            "name": "<string>",
            "amount": 123,
            "quantity": 123,
            "description": "<string>",
            "exempt": False,
            "tax": 123,
            "tax_percent": 123
        }
    ],
    "number": 123,
    "address": "<string>",
    "state": 123,
    "carrier_id": "<string>",
    "carrier_name": "<string>",
    "licence_plate": "<string>",
    "note": "<string>",
    "amount": 123,
    "exempt": 123,
    "tax": 123,
    "tax_percent": 123,
    "total": 123,
    "references": [
        {
            "date": "2023-12-25",
            "document": "<string>",
            "serial": "<string>",
            "description": "<string>"
        }
    ]
}
headers = {
    "x-simple-workspace": "<x-simple-workspace>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-simple-workspace': '<x-simple-workspace>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customer: '<string>',
    document: 123,
    date: '2023-12-25',
    lines: [
      {
        name: '<string>',
        amount: 123,
        quantity: 123,
        description: '<string>',
        exempt: false,
        tax: 123,
        tax_percent: 123
      }
    ],
    number: 123,
    address: '<string>',
    state: 123,
    carrier_id: '<string>',
    carrier_name: '<string>',
    licence_plate: '<string>',
    note: '<string>',
    amount: 123,
    exempt: 123,
    tax: 123,
    tax_percent: 123,
    total: 123,
    references: [
      {
        date: '2023-12-25',
        document: '<string>',
        serial: '<string>',
        description: '<string>'
      }
    ]
  })
};

fetch('https://api.piriod.com/orders/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.piriod.com/orders/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => '<string>',
    'document' => 123,
    'date' => '2023-12-25',
    'lines' => [
        [
                'name' => '<string>',
                'amount' => 123,
                'quantity' => 123,
                'description' => '<string>',
                'exempt' => false,
                'tax' => 123,
                'tax_percent' => 123
        ]
    ],
    'number' => 123,
    'address' => '<string>',
    'state' => 123,
    'carrier_id' => '<string>',
    'carrier_name' => '<string>',
    'licence_plate' => '<string>',
    'note' => '<string>',
    'amount' => 123,
    'exempt' => 123,
    'tax' => 123,
    'tax_percent' => 123,
    'total' => 123,
    'references' => [
        [
                'date' => '2023-12-25',
                'document' => '<string>',
                'serial' => '<string>',
                'description' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "x-simple-workspace: <x-simple-workspace>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.piriod.com/orders/{id}/"

	payload := strings.NewReader("{\n  \"customer\": \"<string>\",\n  \"document\": 123,\n  \"date\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"name\": \"<string>\",\n      \"amount\": 123,\n      \"quantity\": 123,\n      \"description\": \"<string>\",\n      \"exempt\": false,\n      \"tax\": 123,\n      \"tax_percent\": 123\n    }\n  ],\n  \"number\": 123,\n  \"address\": \"<string>\",\n  \"state\": 123,\n  \"carrier_id\": \"<string>\",\n  \"carrier_name\": \"<string>\",\n  \"licence_plate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"amount\": 123,\n  \"exempt\": 123,\n  \"tax\": 123,\n  \"tax_percent\": 123,\n  \"total\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-simple-workspace", "<x-simple-workspace>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.piriod.com/orders/{id}/")
  .header("x-simple-workspace", "<x-simple-workspace>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": \"<string>\",\n  \"document\": 123,\n  \"date\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"name\": \"<string>\",\n      \"amount\": 123,\n      \"quantity\": 123,\n      \"description\": \"<string>\",\n      \"exempt\": false,\n      \"tax\": 123,\n      \"tax_percent\": 123\n    }\n  ],\n  \"number\": 123,\n  \"address\": \"<string>\",\n  \"state\": 123,\n  \"carrier_id\": \"<string>\",\n  \"carrier_name\": \"<string>\",\n  \"licence_plate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"amount\": 123,\n  \"exempt\": 123,\n  \"tax\": 123,\n  \"tax_percent\": 123,\n  \"total\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.piriod.com/orders/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer\": \"<string>\",\n  \"document\": 123,\n  \"date\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"name\": \"<string>\",\n      \"amount\": 123,\n      \"quantity\": 123,\n      \"description\": \"<string>\",\n      \"exempt\": false,\n      \"tax\": 123,\n      \"tax_percent\": 123\n    }\n  ],\n  \"number\": 123,\n  \"address\": \"<string>\",\n  \"state\": 123,\n  \"carrier_id\": \"<string>\",\n  \"carrier_name\": \"<string>\",\n  \"licence_plate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"amount\": 123,\n  \"exempt\": 123,\n  \"tax\": 123,\n  \"tax_percent\": 123,\n  \"total\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "customer": "<string>",
  "document": 123,
  "date": "2023-12-25",
  "lines": [
    {
      "name": "<string>",
      "amount": 123,
      "quantity": 123,
      "id": 123,
      "description": "<string>",
      "exempt": false,
      "tax": 123,
      "tax_percent": 123,
      "total": 123
    }
  ],
  "id": 123,
  "number": 123,
  "address": "<string>",
  "state": 123,
  "carrier_id": "<string>",
  "carrier_name": "<string>",
  "licence_plate": "<string>",
  "note": "<string>",
  "amount": 123,
  "exempt": 123,
  "tax": 123,
  "tax_percent": 123,
  "total": 123,
  "status": "draft",
  "biller_status": "<string>",
  "tax_agency": {},
  "local_file": "<string>",
  "imported": true,
  "test_mode": true,
  "references": [
    {
      "date": "2023-12-25",
      "document": "<string>",
      "serial": "<string>",
      "description": "<string>"
    }
  ],
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace

string

required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode

boolean

default:false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

string

required

Resource identifier.

Body

application/json

Sales / shipping order (e.g. Chilean "guía de despacho"). Documents goods movements that may or may not constitute a sale.

customer

string

required

Customer ID.

document

integer

required

Order document type.

date

string<date>

required

shipping_type

enum<string>

required

Shipping classification: 1 venta, 2 ventas por efectuar, 3 consignaciones, 4 entrega gratuita, 5 traslados internos, 6 otros traslados, 7 guía de devolución, 8 traslado para exportación, 9 venta para exportación.

Available options:

1,

2,

3,

4,

5,

6,

7,

8,

9

lines

object[]

required

Show child attributes

number

integer | null

address

string | null

Maximum string length: 70

state

integer | null

carrier_id

string | null

Maximum string length: 10

carrier_name

string | null

Maximum string length: 30

licence_plate

string | null

Maximum string length: 7

note

string | null

Maximum string length: 100

amount

integer | null

exempt

integer | null

tax

integer | null

tax_percent

number | null

total

integer | null

references

object[]

Show child attributes

Response

200 - application/json

Updated order.

Sales / shipping order (e.g. Chilean "guía de despacho"). Documents goods movements that may or may not constitute a sale.

customer

string

required

Customer ID.

document

integer

required

Order document type.

date

string<date>

required

shipping_type

enum<string>

required

Available options:

1,

2,

3,

4,

5,

6,

7,

8,

9

lines

object[]

required

Show child attributes

integer

read-only

number

integer | null

address

string | null

Maximum string length: 70

state

integer | null

carrier_id

string | null

Maximum string length: 10

carrier_name

string | null

Maximum string length: 30

licence_plate

string | null

Maximum string length: 7

note

string | null

Maximum string length: 100

amount

integer | null

exempt

integer | null

tax

integer | null

tax_percent

number | null

total

integer | null

status

enum<string>

default:draft

read-only

Available options:

draft,

finalized,

cancelled

biller_status

string

read-only

tax_agency

object

read-only

local_file

string<uri> | null

read-only

imported

boolean

read-only

test_mode

boolean

read-only

references

object[]

Show child attributes

created

string<date-time>

read-only

updated

string<date-time>

read-only

Retrieve order Finalize order

Piriod API

Billing

Payments

Procurement

Collections

Partial update order

Authorizations

Headers

Path Parameters

Body

Response