FIfieldpulse
Purchase Orders

Create a puchase order

Changed on

Create a puchase order

post/purchase-orders

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/purchase-orders
  • Auth
    API key in header x-api-key

Request body

vendor_type'third_party' | 'integrated' required
vendor_idstring nullable

Required if vendor_type is third_party. Existing vendor id.

vendor_name'reece'

Required if vendor_type is integrated.

tax_ratestring
titlestring required
status'compose' | 'draft' | 'ordered' | 'pending' | 'route' | 'ready_for_pickup' | 'partially_received' | 'received' | 'completed' | 'canceled' | 'issue'
payment_status'unpaid' | 'partially_paid' | 'paid'
commentstring
order_atinteger required

Unix timestamp.

expected_delivery_atinteger required

Unix timestamp.

received_atinteger

Unix timestamp.

customer_idinteger nullable

Existing customer id.

job_idinteger nullable

Existing job id.

project_idinteger nullable

Existing project id.

invoice_idinteger nullable

Existing invoice id.

assigned_idinteger required

Existing user id.

order_emailstring email required
delivery_method'delivery' | 'pickup' required
delivery_addressstring

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

delivery_flatstring
delivery_citystring

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

delivery_statestring

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

delivery_postcodestring

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

delivery_instructionstring
pickup_branch_idstring

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

order_numberstring

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

order_phonestring

Valid phone number.

Response

Created

errorboolean

false when the request succeeds.

responseobject

The created record.

Changes

  • ee9f1d863d51Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      removed the success response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the success response with the status