[v2.6] PurchaseOrder
Megan Stanage
Overview
This endpoint provides the ability to create or edit purchase orders within SCC.
POST /PurchaseOrder
Represents the purchase order structure.
| Property | Data Type | Notes |
|---|---|---|
| requestedDate | string | Gets or sets the requested date.
|
| confirmedDate | string | Gets or sets the confirmed date.
|
| freightTerm | enum | Gets or sets the freight term.
|
| currencyCode | enum | Gets or sets the currency code. USD, CAD, AUD, GBP, EUR, DKK, SEK, NOK, CZK, CHF, HUF, PLN, MXN, PHP, SAR, JPY, AFN, ALL, DZD, AOA, XCD, ARS, AMD, AWG, AZN, BSD, BHD, BDT, BBD, BYN, BZD, XOF, BMD, INR, BTN, BOB, BOV, BAM, BWP, BRL, BND, BGN, BIF, CVE, KHR, XAF, KYD, CLP, CLF, CNY, COP, COU, KMF, CDF, NZD, CRC, CUP, CUC, ANG, DJF, DOP, EGP, SVC, ERN, SZL, ETB, FKP, FJD, XPF, GMD, GEL, GHS, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, ISK, IDR, XDR, IRR, IQD, ILS, JMD, JOD, KZT, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, ZAR, LRD, LYD, MOP, MKD, MGA, MWK, MYR, MVR, MRU, MUR, XUA, MXV, MDL, MNT, MAD, MZN, MMK, NAD, NPR, NIO, NGN, OMR, PKR, PAB, PGK, PYG, PEN, QAR, RON, RUB, RWF, SHP, WST, STN, RSD, SCR, SLL, SLE, SGD, XSU, SBD, SOS, SSP, LKR, SDG, SRD, CHE, CHW, SYP, TWD, TJS, TZS, THB, TOP, TTD, TND, TRY, TMT, UGX, UAH, AED, USN, UYU, UYI, UYW, UZS, VUV, VES, VED, VND, YER, ZMW, ZWL, XBA, XBB, XBC, XBD, XTS, XXX, XAU, XPD, XPT, XAG |
| purchaseOrderDate | string | Gets or sets the purchase order date.
|
| productionShipToWarehouseId | string | Gets or sets the production ship to warehouse ID. |
| allowConsolidation | boolean | Gets or sets a value indicating whether consolidation is allowed. |
Gets or sets the address to ship from.
| Property | Data Type | Notes |
|---|---|---|
| name | string | max length: 100 |
| company | string | max length: 150 |
| attentionTo | string | max length: 150 |
| addressLines | string | |
| city | string | max length: 150 |
| postalCode | string | max length: 15 |
| stateProvinceCode | string | max length: 5 |
| country | string | |
| countryCode | string | max length: 5 |
| phoneNumber | string | max length: 20 |
| residential | boolean | |
| taxId | string | |
| emailAddress | string | max length: 400 |
| county | string | max length: 30 |
| Property | Data Type | Notes |
|---|---|---|
| vat | string | |
| eori | string |
Gets or sets the list of associated system attributes.
| Property | Data Type | Notes |
|---|---|---|
| attributeName | string | Gets or sets the attribute name. |
| attributeDescription | string | Gets or sets the attribute description. |
| value | string | Gets or sets the system attribute value. |
Gets or sets the purchase order lines.
| Property | Data Type | Notes |
|---|---|---|
| lineNumber | integer | Gets or sets the line number.
|
| hostItem | string | Gets or sets the host item. |
| requestedQuantity | number | Gets or sets the requested quantity.
|
| confirmedQuantity | number | Gets or sets the confirmed quantity.
|
| requestedUnitPrice | number | Gets or sets the requested unit price.
|
| confirmedUnitPrice | number | Gets or sets the confirmed unit price.
|
| quantityUom | string | Gets or sets the quantity UOM. |
| productionItemNumber | string | Gets or sets the production item number. |
| requestedDate | string | Gets or sets the requested date.
|
| confirmedDate | string | Gets or sets the confirmed date.
|
Gets or sets the address to ship to.
| Property | Data Type | Notes |
|---|---|---|
| name | string | max length: 100 |
| company | string | max length: 150 |
| attentionTo | string | max length: 150 |
| addressLines | string | |
| city | string | max length: 150 |
| postalCode | string | max length: 15 |
| stateProvinceCode | string | max length: 5 |
| country | string | |
| countryCode | string | max length: 5 |
| phoneNumber | string | max length: 20 |
| residential | boolean | |
| taxId | string | |
| emailAddress | string | max length: 400 |
| county | string | max length: 30 |
| Property | Data Type | Notes |
|---|---|---|
| vat | string | |
| eori | string |
Gets or sets the associated system attributes.
| Property | Data Type | Notes |
|---|---|---|
| attributeName | string | Gets or sets the attribute name. |
| attributeDescription | string | Gets or sets the attribute description. |
| value | string | Gets or sets the system attribute value. |
Defines the purchase order transaction data structure.
| Property | Data Type | Notes |
|---|---|---|
| workflowTransactionCode | string | Gets or sets the workflow transaction code. |
| referenceNum | string | Gets or sets the reference number. |
| externalReferenceNum | string | Gets or sets the external reference number. |
| note | string | Gets or sets the note. |
| reasonCode | string | Gets or sets the reason code. |
| transactionType | string | Gets or sets the transaction type. |
| businessTransactionType | enum |
|
Gets or sets the list of business transaction partners.
| Property | Data Type | Notes |
|---|---|---|
| name | string | Gets or sets the name. |
| type | enum | Gets or sets the trading partner type.
|
| isPrimary | boolean | Gets or sets a value indicating whether the business transaction partner is primary. |
| Property | Data Type | Notes |
|---|---|---|
| businessTransactionReferenceNum | string | |
| businessTransactionStatus | string |