Replaces a PurchaseOrder object

put

https://qa2.revelup.com/resources/PurchaseOrder/{PurchaseOrderId}/

Replaces a PurchaseOrder object specified by ID

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

PurchaseOrderId

int64

required

ID of PurchaseOrder to replace

Body Params

PurchaseOrder object that needs to be updated

attachment

string

length ≤ 255

File attachment attached to the purchase order

comments

string

length ≤ 255

Human readable text related to this purchase order

contact_email

string

length ≤ 255

Contact email for this purchase order

contact_fax

string

length ≤ 255

Contact fax for this purchase order

contact_name

string

length ≤ 255

Contact name for this purchase order

contact_phone

string

length ≤ 255

Contact phone number for this purchase order

contant_name_for_authorization

string

length ≤ 255

Contact name for authorization for the purchase order

coverage_period

integer

0 to 28

This is an optional field. This field is used in forecasting feature. Minimum coverage period is 1 day and maximum coverage period is 28 days or 4 weeks.

coverage_period_type

integer

enum

Coverage Period type:

1 - Day
7 - Week

Allowed:

created_date

date-time

ISO 8601 Date and time timestamp when PurchaseOrder object was created

establishment

uri

required

URI of an Establishment API object which is related to the PurchaseOrder

expected_delivery_date

date-time

ISO 8601 Date and time timestamp of PurchaseOrder expected delivery date

finalized

boolean

Defaults to false

Boolean value that indicates if a purchase order has been finalized.

finalized_by

uri

URI of an User API object that finalizes the PurchaseOrder

finalized_date

date-time

ISO 8601 Date and time timestamp of when a PurchaseOrder object is finalized

fob

integer

enum

FOB Type:

1 - CFPayFreighttoDestination
2 - FOBDestination
3 - FOBShippingPoint
4 - PayInsuranceandFreighttoDestination

Allowed:

is_deleted

boolean

Defaults to false

Boolean value that indicates if a purchase order has been deleted.

is_sent

boolean

Defaults to false

Boolean value that indicates if a purchase order has been sent.

misc_amount

string

required

Miscellaneous amount of fees attached to the purchase order.

orderitems

array of objects

List of related ProductPurchaseOrderItem API rendered objects

orderitems

overriden_created_date

date-time

ISO 8601 Date and time timestamp when an overriden PurchaseOrder object was created

sent_date

date-time

ISO 8601 Date and time timestamp when PurchaseOrder object was sent

shipping_address1

string

length ≤ 255

Address 1 where the purchase order will be shipped to.

shipping_address2

string

length ≤ 255

Address 2 where the purchase order will be shipped to.

shipping_and_handling

string

required

Shipping and handling price of the purchase order.

shipping_city

string

length ≤ 255

City where the purchase order will be shipped to.

shipping_contact_name

string

length ≤ 255

Contact person name for the purchase order.

shipping_country

string

length ≤ 255

Defaults to USA

Country where the purchase order will be shipped to.

shipping_email

string

length ≤ 255

Contact person email for the purchase order.

shipping_name

string

required

length ≤ 255

Company/ Workplace name for the purchase order.

shipping_phone_number

string

length ≤ 255

Contact phone number for the purchase order

shipping_state

string

length ≤ 255

State where the purchase order will be shipped to.

shipping_terms

string

length ≤ 255

Text field where shipping terms are acknowledged.

shipping_zip

string

length ≤ 255

Zip code where the purchase order will be shipped to.

tax

string

required

Value of the tax applied to the purchase order

total

string

required

Final price of a single purchase order

updated_date

date-time

ISO 8601 Date and time timestamp when PurchaseOrder object was updated

vendor_account_no

string

length ≤ 255

Account number of the vendor ordering the purchase order.

vendor_address1

string

length ≤ 255

Address 1 of the vendor ordering the purchase order.

vendor_address2

string

length ≤ 255

Address 2 of the vendor ordering the purchase order.

vendor_city

string

length ≤ 255

City of the vendor ordering the purchase order.

vendor_contact_name

string

length ≤ 255

Contact person name of the vendor ordering the purchase order.

vendor_country

string

length ≤ 255

Defaults to USA

Country of the vendor ordering the purchase order.

vendor_email

string

length ≤ 255

Email of the vendor ordering the purchase order.

vendor_fax

string

length ≤ 255

Fax number of the vendor ordering the purchase order.

vendor_name

string

required

length ≤ 255

Name of the vendor ordering the purchase order.

vendor_phone_number

string

length ≤ 255

Phone number of the vendor ordering the purchase order.

vendor_state

string

length ≤ 255

State of the vendor ordering the purchase order.

vendor_vat_id

string

length ≤ 255

VAT ID of the vendor ordering the purchase order.

vendor_zip

string

length ≤ 255

Zip code of the vendor ordering the purchase order.

Responses

301

Invalid request URL - make sure that the URL ends with a trailing slash.

400

Bad request. Usually caused by invalid request body.

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

404

PurchaseOrder with the provided ID not found.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Coverage Period type:

FOB Type:

201Resource successfully replaced