- BOMs
- Gets Boms that user has read access toGET
- Creates a Bom using Cofactr DataPOST
- Creates a Bom using raw bomline data and performs searches to convert into Cofactr DataPOST
- Gets a BomGET
- Upsert BOM AsyncPUT
- Updates a BomPATCH
- Deletes a Bom if still unapproved. Archives a bom if approved.DELETE
- Approves an unapproved Bom.POST
- Gets Bom Lines on a Bom.GET
- Creates a new bomline on a Bom using Cofactr data. If a bomline with the provided part exists it will sum the quants instead of duplicating lines.POST
- Gets a BomLineGET
- Updates a BomLinePATCH
- Removes a Bomline from a Bom.DELETE
- Attempts to create a new Bomline using raw data and performs searches to convert into Cofactr Data. If a Bomline with the same part and refdes exists it will sum the quants instead of duplicating lines.POST
- Programs
- Gets Programs
- Creates a Program
- Gets a Program
- Updates a Program
- Deletes a Program
- Gets Program Availabilities
- Gets Program Availabilities Async
- Gets Program Reference Pricing
- Get Programs Lines
- Get Programs Line
- Update Programs Line
- Delete Programs Line
- Create Programs Lines
- Get Program Part Overrides
- Create Program Part Overrides
- Get Program Part Override
- Update Program Part Override
- Delete Program Part Override
- Account
- Reporting
- Email
- Auth
- Async Jobs
- Stock Documents
- Suppliers
- Parts
- Purchases
- Get Purchase OrderGET
- Create Purchase OrderPOST
- Update Purchase OrderPATCH
- Delete Purchase OrderDELETE
- Get Purchase LinesGET
- Get Purchase LineGET
- Create Purchase LinePOST
- Update Many Purchase LinesPATCH
- Delete Purchase LineDELETE
- Get NoPart Purchase LinesGET
- Create NoPart Purchase LinePOST
- Update Many NoPart Purchase LinesPATCH
- Delete NoPart Purchase LineDELETE
- Create Purchase EventPOST
- Update Supplier BillPATCH
- Update Supplier Bill LinePATCH
- Create Supplier BillPOST
- Create Supplier Bill LinePOST
- Teams
- Custom Properties
- Stock Lots
- Tags
- Rfqs
- RfqLines
- SupplierQuote
- SupplierQuoteLines
Create Purchase Line
POST
/v1/purchase_orders/{purchase_id}/lines/
Request
Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params
purchase_id
string
required
Query Params
blended
string
optional
Header Params
x-org-id
string
optional
Body Params application/json
synced_from_integration
boolean
Synced from integration
integration_source_name
string
Integration source name
integration_record_id
string
Integration record id
synced_from_integration_at
string <date-time>
Synced from integration at
metadata
object
Metadata
notes
string
Notes
>= 1 characters
quant
string <decimal>
Quant
part_id
string
Part id
>= 1 characters
line_total_expected
string <decimal>
Line total expected
line_total_paid
string <decimal>
Line total paid
shipping_paid
string <decimal>
Shipping paid
duties_paid
string <decimal>
Duties paid
other_total_paid
string <decimal>
Other total paid
adjustment
string <decimal>
Adjustment
link
string <uri>
Link
need_delivery_by
string <date>
Need delivery by
expected_ship_by
string <date>
Expected ship by
returnable_until
string <date>
Returnable until
release_deadline
string <date>
Release deadline
release_date
string <date>
Release date
estimated_delivery
string <date>
Estimated delivery
confirmed_at
string <date-time>
Confirmed at
shipped_at
string <date-time>
Shipped at
delivered_at
string <date-time>
Delivered at
received_at
string <date-time>
Received at
returned_at
string <date-time>
Returned at
canceled_at
string <date-time>
Canceled at
expected_ships_in
integer
Expected ships in
expected_transit_time
integer
Expected transit time
package
enum<string>
Package
Allowed values:
tubetraybulktape_singletape_multiplereelunknown
is_backordered
boolean
Is backordered
is_uncertain_lead
boolean
Is uncertain lead
sku
string
Sku
>= 1 characters
program_id
string <uuid>
Program id
split_from_id
string <uuid>
Split from id
purchase_request_id
string <uuid>
Purchase request id
confirmed_by_id
string <uuid>
Confirmed by id
shipped_by_id
string <uuid>
Shipped by id
received_by_id
string <uuid>
Received by id
returned_by_id
string <uuid>
Returned by id
canceled_by_id
string <uuid>
Canceled by id
quote_id
string <uuid>
Quote id
Example
[
{
"adjustment": 100,
"integration_record_id": "",
"metadata": {
"test": "eeeerrrr"
},
"is_backordered": false,
"is_uncertain_lead": false,
"part_id": "CTSOOTMUOPYG",
"quant": "10",
"line_total_expected": 100,
"line_total_paid": 100,
"shipping_paid": 100,
"duties_paid": 100,
"other_total_paid": 100,
"link": "http://google.com",
"expected_ships_in": 2,
"expected_transit_time": 3,
"package": "reel",
"notes": "The is a test"
},
{
"adjustment": 100,
"integration_record_id": "",
"metadata": {
"test": "eeeerrrr"
},
"is_backordered": false,
"is_uncertain_lead": false,
"part_id": "RCGJ7WYX8GXO",
"quant": "10",
"line_total_expected": 100,
"line_total_paid": 100,
"shipping_paid": 100,
"duties_paid": 100,
"other_total_paid": 100,
"link": "http://google.com",
"expected_ships_in": 2,
"expected_transit_time": 3,
"package": "reel",
"notes": "The is a test"
},
{
"adjustment": 100,
"integration_record_id": "",
"metadata": {
"test": "eeeerrrr"
},
"is_backordered": false,
"is_uncertain_lead": false,
"part_id": "RCVWQ1GXU01C",
"quant": "10",
"line_total_expected": 100,
"line_total_paid": 100,
"shipping_paid": 100,
"duties_paid": 100,
"other_total_paid": 100,
"link": "http://google.com",
"expected_ships_in": 2,
"expected_transit_time": 3,
"package": "reel",
"notes": "The is a test"
}
]
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/purchase_orders//lines/?blended' \
--header 'x-org-id;' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '[
{
"adjustment": "50.00",
"integration_record_id": "",
"metadata": {
"test": "eeeerrrr"
},
"is_backordered": false,
"is_uncertain_lead": false,
"part_id": "CTSOOTMUOPYG",
"quant": "10",
"line_total_expected": 100,
"line_total_paid": 100,
"shipping_paid": 100,
"duties_paid": 100,
"other_total_paid": 100,
"adjustment": 100,
"link": "http://google.com",
"expected_ships_in": 2,
"expected_transit_time": 3,
"package": "reel",
"notes": "The is a test"
},
{
"adjustment": "50.00",
"integration_record_id": "",
"metadata": {
"test": "eeeerrrr"
},
"is_backordered": false,
"is_uncertain_lead": false,
"part_id": "RCGJ7WYX8GXO",
"quant": "10",
"line_total_expected": 100,
"line_total_paid": 100,
"shipping_paid": 100,
"duties_paid": 100,
"other_total_paid": 100,
"adjustment": 100,
"link": "http://google.com",
"expected_ships_in": 2,
"expected_transit_time": 3,
"package": "reel",
"notes": "The is a test"
},
{
"adjustment": "50.00",
"integration_record_id": "",
"metadata": {
"test": "eeeerrrr"
},
"is_backordered": false,
"is_uncertain_lead": false,
"part_id": "RCVWQ1GXU01C",
"quant": "10",
"line_total_expected": 100,
"line_total_paid": 100,
"shipping_paid": 100,
"duties_paid": 100,
"other_total_paid": 100,
"adjustment": 100,
"link": "http://google.com",
"expected_ships_in": 2,
"expected_transit_time": 3,
"package": "reel",
"notes": "The is a test"
}
]'
Responses
🟢200Success
application/json
Body
array of:
id
string <uuid>
Id
metadata
object
Metadata
synced_from_integration
boolean
Synced from integration
synced_from_integration_at
string <date-time>
Synced from integration at
integration_source_name
string
Integration source name
>= 1 characters
integration_record_id
string
Integration record id
>= 1 characters
notes
string
Notes
>= 1 characters
quant
string <decimal>
Quant
part
object (OrgPart)
optional
id
string <uuid>
Id
created_at
string <date-time>
Created at
updated_at
string <date-time>
Updated at
custom_id
string
Custom id
<= 255 characters
org_id
string
Org id
cofactr_id
string
Cofactr id
>= 1 characters
aec
enum<string>
Aec
Allowed values:
AEC-Q001AEC-Q002AEC-Q003AEC-Q004AEC-Q005AEC-Q006AEC-Q100AEC-Q101AEC-Q102AEC-Q103AEC-Q104AEC-Q200AEC-Q unknown
classification
string
Classification
<= 255 characters
description
string
Description
hero_image
string
Hero image
<= 255 characters
lifecycle_status
enum<string>
Lifecycle status
Allowed values:
NewProductionEOLNRFNDObsolete
mfg
string
Mfg
<= 255 characters
mpn
string
Mpn
<= 255 characters
msl
string
Msl
<= 2 characters
package
string
Package
<= 255 characters
reach
enum<string>
Reach
Allowed values:
REACH AffectedREACH CompliantREACH Non-CompliantREACH UnaffectedREACH Unknown
rohs
enum<string>
Rohs
Allowed values:
RoHS Compliant by ExemptionRoHS CompliantRoHS Non-CompliantRoHS UnknownRoHS3 Compliant by ExemptionRoHS3 Compliant
termination_type
string
Termination type
<= 255 characters
terminations
integer
Terminations
>= -2147483648<= 2147483647
last_synced_at
string
Last synced at
custom_properties
object
Custom properties
line_total_expected
string <decimal>
Line total expected
line_total_paid
string <decimal>
Line total paid
shipping_paid
string <decimal>
Shipping paid
duties_paid
string <decimal>
Duties paid
other_total_paid
string <decimal>
Other total paid
adjustment
string <decimal>
Adjustment
link
string <uri>
Link
<= 200 characters
need_delivery_by
string <date>
Need delivery by
expected_ship_by
string <date>
Expected ship by
returnable_until
string <date>
Returnable until
release_deadline
string <date>
Release deadline
release_date
string <date>
Release date
estimated_delivery
string <date>
Estimated delivery
confirmed_at
string <date-time>
Confirmed at
shipped_at
string <date-time>
Shipped at
delivered_at
string <date-time>
Delivered at
received_at
string <date-time>
Received at
returned_at
string <date-time>
Returned at
canceled_at
string <date-time>
Canceled at
expected_ships_in
integer
Expected ships in
>= -2147483648<= 2147483647
expected_transit_time
integer
Expected transit time
>= -2147483648<= 2147483647
package
enum<string>
Package
Allowed values:
tubetraybulktape_singletape_multiplereelunknown
is_backordered
boolean
Is backordered
is_uncertain_lead
boolean
Is uncertain lead
sku
string
Sku
>= 1 characters
program
object (ProgramRelatedRecord)
Program
name
string
required
record_type
enum<string>
required
Allowed values:
bom_batchproduction_run
record_id
string <uuid>
required
org_id
string <uuid>
required
split_from_id
string <uuid>
Split from id
quote
object (Quote)
optional
id
string <uuid>
Id
synced_from_integration
boolean
Synced from integration
synced_from_integration_at
string <date-time>
Synced from integration at
integration_source_name
string
Integration source name
>= 1 characters
integration_record_id
string
Integration record id
>= 1 characters
metadata
object
Metadata
notes
string
Notes
>= 1 characters
org_id
string <uuid>
Org id
status
string
Status
method
string
Method
>= 1 characters
part_id
string
Part id
>= 1 characters
cofactr_quote_id
string
Cofactr quote id
>= 1 characters
request_submitted_at
string <date-time>
Request submitted at
response_received_at
string <date-time>
Response received at
rejected_at
string <date-time>
Rejected at
expires_at
string <date-time>
Expires at
link
string <uri>
Link
<= 200 characters
requested_quantity
integer
Requested quantity
moq
integer
Moq
>= -2147483648<= 2147483647
multiple
integer
Multiple
>= -2147483648<= 2147483647
maximum
integer
Maximum
>= -2147483648<= 2147483647
lead
integer
Lead
>= -2147483648<= 2147483647
additional_flat
string <decimal>
Additional flat
additional_percentage
string <decimal>
Additional percentage
shipping
string <decimal>
Shipping
authorized_supplier
boolean
Authorized supplier
prices
array[object (PriceBreak) {2}]
required
supplier_id
string <uuid>
Supplier id
org_supplier_id
string <uuid>
Org supplier id
quote_request_id
string <uuid>
Quote request id
purchase_request
object (PurchaseRequest)
optional
id
string <uuid>
Id
metadata
object
Metadata
synced_from_integration
boolean
Synced from integration
synced_from_integration_at
string <date-time>
Synced from integration at
integration_source_name
string
Integration source name
>= 1 characters
integration_record_id
string
Integration record id
>= 1 characters
status
string
Status
requested_by
object (User)
optional
requested_at
string <date-time>
Requested at
requested_notes
string
Requested notes
team
object (TeamLite)
optional
kb_offer
object
Kb offer
org_id
string <uuid>
Org id
part_id
string
Part id
>= 1 characters
quantity
integer
Quantity
rejected_at
string <date-time>
Rejected at
assigned_by
string <uuid>
Assigned by
assigned_to
string <uuid>
Assigned to
approved_by
string <uuid>
Approved by
archived_by
string <uuid>
Archived by
rejected_by
string <uuid>
Rejected by
supplier_id
string <uuid>
Supplier id
program_id
string <uuid>
Program id
ship_to_id
string <uuid>
Ship to id
purchase_rule_id
string <uuid>
Purchase rule id
confirmed_by
object (User)
optional
shipped_by
object (User)
optional
received_by
object (User)
optional
returned_by
object (User)
optional
canceled_by
object (User)
optional
purchase_order_id
string <uuid>
Purchase order id
team
object (TeamLite)
optional
unit_price
string
Unit price
custom_properties
object
Custom properties
Example
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": {},
"synced_from_integration": true,
"synced_from_integration_at": "2019-08-24T14:15:22Z",
"integration_source_name": "string",
"integration_record_id": "string",
"notes": "string",
"quant": "string",
"part": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"custom_id": "string",
"org_id": "string",
"cofactr_id": "string",
"aec": "AEC-Q001",
"classification": "string",
"description": "string",
"hero_image": "string",
"lifecycle_status": "New",
"mfg": "string",
"mpn": "string",
"msl": "st",
"package": "string",
"reach": "REACH Affected",
"rohs": "RoHS Compliant by Exemption",
"termination_type": "string",
"terminations": -2147483648,
"last_synced_at": "string",
"custom_properties": {}
},
"line_total_expected": "string",
"line_total_paid": "string",
"shipping_paid": "string",
"duties_paid": "string",
"other_total_paid": "string",
"adjustment": "string",
"link": "http://example.com",
"need_delivery_by": "2019-08-24",
"expected_ship_by": "2019-08-24",
"returnable_until": "2019-08-24",
"release_deadline": "2019-08-24",
"release_date": "2019-08-24",
"estimated_delivery": "2019-08-24",
"confirmed_at": "2019-08-24T14:15:22Z",
"shipped_at": "2019-08-24T14:15:22Z",
"delivered_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"returned_at": "2019-08-24T14:15:22Z",
"canceled_at": "2019-08-24T14:15:22Z",
"expected_ships_in": -2147483648,
"expected_transit_time": -2147483648,
"package": "tube",
"is_backordered": true,
"is_uncertain_lead": true,
"sku": "string",
"program": {
"name": "string",
"record_type": "bom_batch",
"record_id": "8bf519b6-a3e0-49d2-8e42-039542d9a489",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b"
},
"split_from_id": "5b2be705-c96c-46b0-a576-ddecd95a4019",
"quote": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"synced_from_integration": true,
"synced_from_integration_at": "2019-08-24T14:15:22Z",
"integration_source_name": "string",
"integration_record_id": "string",
"metadata": {},
"notes": "string",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
"status": "string",
"method": "string",
"part_id": "string",
"cofactr_quote_id": "string",
"request_submitted_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"rejected_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"link": "http://example.com",
"requested_quantity": 0,
"moq": -2147483648,
"multiple": -2147483648,
"maximum": -2147483648,
"lead": -2147483648,
"additional_flat": "string",
"additional_percentage": "string",
"shipping": "string",
"authorized_supplier": true,
"prices": [
{
"price_break": -2147483648,
"price": "string"
}
],
"supplier_id": "3cb1e20c-c6c9-4e71-ba66-399c468f697c",
"org_supplier_id": "863f230f-b11e-4e2b-b6e0-de6cb1b7a3e3",
"quote_request_id": "0e1e732f-b710-4548-aa3b-23018de5bc5e"
},
"purchase_request": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": {},
"synced_from_integration": true,
"synced_from_integration_at": "2019-08-24T14:15:22Z",
"integration_source_name": "string",
"integration_record_id": "string",
"status": "string",
"requested_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"title": "string",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b"
},
"requested_at": "2019-08-24T14:15:22Z",
"requested_notes": "string",
"team": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
"team_type": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"plural_name": "string",
"org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba"
},
"external_metadata": {},
"internal_metadata": {},
"archived": "string"
},
"kb_offer": {
"property1": "string",
"property2": "string"
},
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
"part_id": "string",
"quantity": 0,
"rejected_at": "2019-08-24T14:15:22Z",
"assigned_by": "dd7cba77-7080-4b0e-9a94-fdfd1232f6b4",
"assigned_to": "b9f52997-ff03-4166-bbff-22fd35e12939",
"approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
"archived_by": "b5dab088-5678-4dc8-a1b2-f7b300fd8a85",
"rejected_by": "90f2bd82-969c-453e-94eb-690792e1ab72",
"supplier_id": "3cb1e20c-c6c9-4e71-ba66-399c468f697c",
"program_id": "70c1146b-e933-4cb2-a789-bbca5312b517",
"ship_to_id": "bb721090-fa9a-4e46-8bd9-b2279823a3ba",
"purchase_rule_id": "0e8ac4c6-7d4a-47a5-953e-2a0e65def74e"
},
"confirmed_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"title": "string",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b"
},
"shipped_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"title": "string",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b"
},
"received_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"title": "string",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b"
},
"returned_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"title": "string",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b"
},
"canceled_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"title": "string",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b"
},
"purchase_order_id": "21637704-484e-4c9d-a7ca-e34984d27d80",
"team": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
"team_type": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"plural_name": "string",
"org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba"
},
"external_metadata": {},
"internal_metadata": {},
"archived": "string"
},
"unit_price": "string",
"custom_properties": {}
}
]
Modified at 2025-02-06 23:25:41