Create a puchase order

curl --request POST \
  --url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/purchase-orders \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "vendor_type": "third_party",
  "title": "some string",
  "payment_status": "unpaid",
  "order_at": 1234567890,
  "expected_delivery_at": 1234567890,
  "assigned_id": 1,
  "order_email": "user@example.com",
  "delivery_method": "delivery"
}
'

import requests

url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/purchase-orders"

payload = {
    "vendor_type": "third_party",
    "title": "some string",
    "payment_status": "unpaid",
    "order_at": 1234567890,
    "expected_delivery_at": 1234567890,
    "assigned_id": 1,
    "order_email": "user@example.com",
    "delivery_method": "delivery"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    vendor_type: 'third_party',
    title: 'some string',
    payment_status: 'unpaid',
    order_at: 1234567890,
    expected_delivery_at: 1234567890,
    assigned_id: 1,
    order_email: 'user@example.com',
    delivery_method: 'delivery'
  })
};

fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/purchase-orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": false,
  "response": {}
}

{
  "error": true,
  "errors": [
    "error message",
    "error message"
  ]
}

{
  "message": "Unauthorized"
}

{
  "message": "Request URL not found"
}

{
  "message": "Internal Server Error"
}

POST

purchase-orders

Create a puchase order

curl --request POST \
  --url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/purchase-orders \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "vendor_type": "third_party",
  "title": "some string",
  "payment_status": "unpaid",
  "order_at": 1234567890,
  "expected_delivery_at": 1234567890,
  "assigned_id": 1,
  "order_email": "user@example.com",
  "delivery_method": "delivery"
}
'

import requests

url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/purchase-orders"

payload = {
    "vendor_type": "third_party",
    "title": "some string",
    "payment_status": "unpaid",
    "order_at": 1234567890,
    "expected_delivery_at": 1234567890,
    "assigned_id": 1,
    "order_email": "user@example.com",
    "delivery_method": "delivery"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    vendor_type: 'third_party',
    title: 'some string',
    payment_status: 'unpaid',
    order_at: 1234567890,
    expected_delivery_at: 1234567890,
    assigned_id: 1,
    order_email: 'user@example.com',
    delivery_method: 'delivery'
  })
};

fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/purchase-orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": false,
  "response": {}
}

{
  "error": true,
  "errors": [
    "error message",
    "error message"
  ]
}

{
  "message": "Unauthorized"
}

{
  "message": "Request URL not found"
}

{
  "message": "Internal Server Error"
}

Body raw (json)

{
  "vendor_type",// required | string | acceptable_values: third_party,integrated
  "vendor_id",// nullable | required, if vendor_type is third_party | existing vendor id
  "vendor_name",// required if vendor_type is integrated | string | acceptable_values: reece
  "tax_rate",// optional | string
  "title",// required | string | max:255
  "status",// optional | string | acceptable_values: compose,draft,ordered,pending,route,ready_for_pickup,partially_received,received,completed,canceled,issue
  "payment_status",// optional | string | acceptable_values: unpaid,partially_paid,paid
  "comment",// optional | string | max:5000
  "order_at",// required | timestamp
  "expected_delivery_at",// required | timestamp
  "received_at",// optional | timestamp
  "customer_id",// nullable | integer | existing customer id
  "job_id",// nullable | integer | existing job id
  "project_id",// nullable | integer | existing project id
  "invoice_id",// nullable | integer | existing invoice id
  "assigned_id",// required | integer | existing user id
  "order_email",// required | email | max:255
  "delivery_method",// required | string | acceptable_values: delivery,pickup
  "delivery_address",// string | required, if vendor_type is integrated,vendor_name is reece,delivery_method is delivery
  "delivery_flat",// optional | string
  "delivery_city",// string | required, if vendor_type is integrated,vendor_name is reece,delivery_method is delivery
  "delivery_state",// string | required, if vendor_type is integrated,vendor_name is reece,delivery_method is delivery
  "delivery_postcode",// string | required, if vendor_type is integrated,vendor_name is reece,delivery_method is delivery
  "delivery_instruction",// optional | string
  "pickup_branch_id",// required, if vendor_type is integrated,vendor_name is reece,delivery_method is pickup
  "order_number",// required, if vendor_type is integrated,vendor_name is reece or reece-us | string | max:255
  "order_phone",// optional | string | description: valid phone number
  "items": [// optional | array
    {
      "id",// nullable | integer
      "item_id",// required | integer
      "title",// required | string | max:400
      "type",// required | string | acceptable_values: reece,fieldpulse
      "unit_measure",// required, if type is reece | string | max:10
      "unit_cost",// required | string | max:10
      "is_taxed",// optional | boolean
      "tax_rate",// optional | string
      "quantity",// required | string | max:10
      "payment_status"// required | string | acceptable_values: unpaid,paid
    }
  ],
  "customfields": [ // optional | array | description: array of custom fleds
        {
            "id", // optional | nullable | required if field_instance_id is not set | integer | custom field id
            "field_instance_id", // optional | nullable | required if id is not set | integer | custom field instance id
            "value" // required | string | custom value
        },
        {
            "id", // optional | nullable | required if field_instance_id is not set | integer | custom field id
            "field_instance_id", // optional | nullable | required if id is not set | integer | custom field instance id
            "value" // required | string | custom value
        }
    ]
}

Authorizations

x-api-key

string

header

required

Body

application/json

vendor_type

enum<string>

required

Available options:

third_party,

integrated

title

string

required

Maximum string length: 255

order_at

integer

required

Unix timestamp.

expected_delivery_at

integer

required

Unix timestamp.

assigned_id

integer

required

Existing user id.

order_email

string<email>

required

Maximum string length: 255

delivery_method

enum<string>

required

Available options:

delivery,

pickup

vendor_id

string | null

Required if vendor_type is third_party. Existing vendor id.

vendor_name

enum<string>

Required if vendor_type is integrated.

Available options:

reece

tax_rate

string

status

enum<string>

Available options:

compose,

draft,

ordered,

pending,

route,

ready_for_pickup,

partially_received,

received,

completed,

canceled,

issue

payment_status

enum<string>

Available options:

unpaid,

partially_paid,

paid

comment

string

Maximum string length: 5000

received_at

integer

Unix timestamp.

customer_id

integer | null

Existing customer id.

job_id

integer | null

Existing job id.

project_id

integer | null

Existing project id.

invoice_id

integer | null

Existing invoice id.

delivery_address

string

Required if vendor_type is integrated,vendor_name is reece,delivery_method is delivery.

delivery_flat

string

delivery_city

string

Required if vendor_type is integrated,vendor_name is reece,delivery_method is delivery.

delivery_state

string

Required if vendor_type is integrated,vendor_name is reece,delivery_method is delivery.

delivery_postcode

string

Required if vendor_type is integrated,vendor_name is reece,delivery_method is delivery.

delivery_instruction

string

pickup_branch_id

string

Required if vendor_type is integrated,vendor_name is reece,delivery_method is pickup.

order_number

string

Required if vendor_type is integrated,vendor_name is reece or reece-us.

Maximum string length: 255

order_phone

string

Valid phone number.

items

object[]

Hide child attributes

items.item_id

integer

required

items.title

string

required

Maximum string length: 400

items.type

enum<string>

required

Available options:

reece,

fieldpulse

items.unit_cost

string

required

Maximum string length: 10

items.quantity

string

required

Maximum string length: 10

items.payment_status

enum<string>

required

Available options:

unpaid,

paid

items.id

integer | null

items.unit_measure

string

Required if type is reece.

Maximum string length: 10

items.is_taxed

boolean

items.tax_rate

string

customfields

object[]

Array of custom fields.

Hide child attributes

customfields.value

string

required

Custom value.

customfields.id

integer | null

Required if field_instance_id is not set. Custom field id.

customfields.field_instance_id

integer | null

Required if id is not set. Custom field instance id.

Response

Created

error

boolean

false when the request succeeds.

Example:

false

response

object

The created record.

Get Started

Assets

Assets Category

Comments

Company Profile

Contracts

Customers

Custom Fields

Estimates

Invoices

Items

Jobs

Lead Source

Locations

Material Lists

Payments

Pipeline Status

Projects

Purchase Orders

Subtasks

Tags

Teams

Timesheets

Users

Vendors

Version

Create a puchase order

Authorizations

Body

Response