API docs by Redocly

Elemica Buy API (0.9)

Download OpenAPI specification:Download

Business rules

Please note that a supplier may impose business rules to address conditional requirements of theirs. Below you find a list of the ones a supplier can opt-in:

Business rule Description
8 Each Order Create (PO), Order Change, and Order Response will have a single value for ShipTo mapped to the Partners structure
14 Buyer Purchase Orders will be uniquely identified by the field BuyerOrderReference
32 Each Purchase Order will have a single shipment term and location across all line items
40 BuyerOrderReference must be expressed as number
80 ShipmentTerms are required for direct pickup orders (EXW, FCA)
81 Buyer is required to explicitely set OrderType
82 DeliveryDateTime is mandatory

Please reach out to the Elemica onboarding team in order to learn about the business rules your supplier mandates.

Buy

Publishes a Purchase Order via Elemica

A buyer can publish a Purchase Order through that endpoint

path Parameters
endpoint
required
string

endpoint provided by Elemica to post to. Please note that Elemica will provide two endpoints, one for test the other for production

header Parameters
X-PO-SENDER-SYSTEM-ID
required
string <uuid>

unique PO system reference for callbacks

Request Body schema: application/json
required
TransmissionReference
required
string <uuid> (TransmissionReference)
required
object (BusinessPartner)
required
object (BusinessPartner)
required
object (BusinessPartner)
required
object (BusinessPartner)
object (BusinessPartner)
object (BusinessPartner)
OrderType
string (PurchaseOrderType)
Enum: "Agreement" "Assortment_Blanket" "Authority_Proceed" "Bailment" "Basic_Agreement" "Bidding" "Bill_Hold" "Blanket" "Blanket_Estimated_Quantity" "Blanket_Firm_Quantity" "Budget_Quote" "Buying" "Catalog" "Change" "Change_Contract" "Change_Release" "Close" "Confirmation" "Consignment_Issue" "Consignment_Order" "Contract" "Contract_Letter" "Contract_Notification" "Direct_Ship" "Drop_Ship" "Emergency" "Exchange" "Fabricate_Hold" "Formula_Fund" "Grant" "Ground_Aircraft_Critical" "Ground_Aircraft_Service" "Indefinite_Delivery" "Indefinite_Delivery_Quantity" "Information" "Internal_Order" "Job" "Lease" "Lease_Blanket" "Loan" "Mutually_Defined" "New" "Not_Sale" "Ordering_Agreement" "Product_Introduction" "Promotion" "Record_Service" "Release" "Release_Delivery" "Renewal" "Rental" "Reorder" "Repair_Return" "Requirements" "Resume_Order" "Retailer_Commitment" "Rush" "Sample" "Service_Order" "Special_Order" "Stand_Alone" "Standard" "Standing_Order" "Stop" "Store_Opening" "Task" "Termination" "Time_Materials" "Toll" "Unit_Down" "Unit_Exchange" "Urgent_Request" "Warranty" "Framework_Order" "Indent_Order" "Intercompany" "Shipped" "Swap"
OrderLanguage
string (Language)
Enum: "aar" "abk" "ace" "ach" "ada" "ady" "afa" "afh" "afr" "ain" "aka" "akk" "alb" "ale" "alg" "alt" "amh" "ang" "anp" "apa" "ara" "arc" "arg" "arm" "arn" "arp" "art" "arw" "asm" "ast" "ath" "aus" "ava" "ave" "awa" "aym" "aze" "bad" "bai" "bak" "bal" "bam" "ban" "baq" "bas" "bat" "bej" "bel" "bem" "ben" "ber" "bho" "bih" "bik" "bin" "bis" "bla" "bnt" "bod" "bos" "bra" "bre" "btk" "bua" "bug" "bul" "bur" "byn" "cad" "cai" "car" "cat" "cau" "ceb" "cel" "ces" "cha" "chb" "che" "chg" "chi" "chk" "chm" "chn" "cho" "chp" "chr" "chu" "chv" "chy" "cmc" "cnr" "cop" "cor" "cos" "cpe" "cpf" "cpp" "cre" "crh" "crp" "csb" "cus" "cym" "cze" "dak" "dan" "dar" "day" "del" "den" "deu" "dgr" "din" "div" "doi" "dra" "dsb" "dua" "dum" "dut" "dyu" "dzo" "efi" "egy" "eka" "ell" "elx" "eng" "enm" "epo" "est" "eus" "ewe" "ewo" "fan" "fao" "fas" "fat" "fij" "fil" "fin" "fiu" "fon" "fra" "fre" "frm" "fro" "frr" "frs" "fry" "ful" "fur" "gaa" "gay" "gba" "gem" "geo" "ger" "gez" "gil" "gla" "gle" "glg" "glv" "gmh" "goh" "gon" "gor" "got" "grb" "grc" "gre" "grn" "gsw" "guj" "gwi" "hai" "hat" "hau" "haw" "heb" "her" "hil" "him" "hin" "hit" "hmn" "hmo" "hrv" "hsb" "hun" "hup" "hye" "iba" "ibo" "ice" "ido" "iii" "ijo" "iku" "ile" "ilo" "ina" "inc" "ind" "ine" "inh" "ipk" "ira" "iro" "isl" "ita" "jav" "jbo" "jpn" "jpr" "jrb" "kaa" "kab" "kac" "kal" "kam" "kan" "kar" "kas" "kat" "kau" "kaw" "kaz" "kbd" "kha" "khi" "khm" "kho" "kik" "kin" "kir" "kmb" "kok" "kom" "kon" "kor" "kos" "kpe" "krc" "krl" "kro" "kru" "kua" "kum" "kur" "kut" "lad" "lah" "lam" "lao" "lat" "lav" "lez" "lim" "lin" "lit" "lol" "loz" "ltz" "lua" "lub" "lug" "lui" "lun" "luo" "lus" "mac" "mad" "mag" "mah" "mai" "mak" "mal" "man" "mao" "map" "mar" "mas" "may" "mdf" "mdr" "men" "mga" "mic" "min" "mis" "mkd" "mkh" "mlg" "mlt" "mnc" "mni" "mno" "moh" "mon" "mos" "mri" "msa" "mul" "mun" "mus" "mwl" "mwr" "mya" "myn" "myv" "nah" "nai" "nap" "nau" "nav" "nbl" "nde" "ndo" "nds" "nep" "new" "nia" "nic" "niu" "nld" "nno" "nob" "nog" "non" "nor" "nqo" "nso" "nub" "nwc" "nya" "nym" "nyn" "nyo" "nzi" "oci" "oji" "ori" "orm" "osa" "oss" "ota" "oto" "paa" "pag" "pal" "pam" "pan" "pap" "pau" "peo" "per" "phi" "phn" "pli" "pol" "pon" "por" "pra" "pro" "pus" "que" "raj" "rap" "rar" "roa" "roh" "rom" "ron" "rum" "run" "rup" "rus" "sad" "sag" "sah" "sai" "sal" "sam" "san" "sas" "sat" "scn" "sco" "sel" "sem" "sga" "sgn" "shn" "sid" "sin" "sio" "sit" "sla" "slk" "slo" "slv" "sma" "sme" "smi" "smj" "smn" "smo" "sms" "sna" "snd" "snk" "sog" "som" "son" "sot" "spa" "sqi" "srd" "srn" "srp" "srr" "ssa" "ssw" "suk" "sun" "sus" "sux" "swa" "swe" "syc" "syr" "tah" "tai" "tam" "tat" "tel" "tem" "ter" "tet" "tgk" "tgl" "tha" "tib" "tig" "tir" "tiv" "tkl" "tlh" "tli" "tmh" "tog" "ton" "tpi" "tsi" "tsn" "tso" "tuk" "tum" "tup" "tur" "tut" "tvl" "twi" "tyv" "udm" "uga" "uig" "ukr" "umb" "und" "urd" "uzb" "vai" "ven" "vie" "vol" "vot" "wak" "wal" "war" "was" "wel" "wen" "wln" "wol" "xal" "xho" "yao" "yap" "yid" "yor" "ypk" "zap" "zbl" "zen" "zgh" "zha" "zho" "znd" "zul" "zun" "zxx" "zza"

language according to ISO 639-2

BuyerOrderReference
required
string

Buyer's Purchase Order reference

BuyerOrderIssueDate
required
string <date-time> (DateTime)
object (FreeTextCollection)
required
Array of objects (LineItem)
Array of objects (Attachment)

Responses

Request samples

Content type
application/json
{
  • "TransmissionReference": "e63c97aa-34c8-4a2a-a4b8-8f9a4d6bd002",
  • "SenderParty": {
    },
  • "ReceiverParty": {
    },
  • "BuyerParty": {
    },
  • "SellerParty": {
    },
  • "BillToParty": {
    },
  • "PayerParty": {
    },
  • "OrderType": "Standard",
  • "OrderLanguage": "deu",
  • "BuyerOrderReference": "string",
  • "BuyerOrderIssueDate": "2019-08-24T14:15:22Z",
  • "OrderInstructions": {
    },
  • "lineItems": [
    ],
  • "attachments": [
    ]
}

Acknowledge

Acknowledge receipt by the supplier for a previously submitted Purchase Order

A supplier can confirm a previously submitted purchase order

path Parameters
order_uuid
required
string

buyer or market place can provide a unique system id of the posted purchase order

Request Body schema: application/json
required
TransmissionReference
required
string <uuid> (TransmissionReference)
ProcessingIndicator
required
string (ProcessingIndicator)
Enum: "Accepted" "Rejected"
RejectReason
string (RejectReason)

detailed description in terms of why a request failed

Responses

Request samples

Content type
application/json
{
  • "TransmissionReference": "e63c97aa-34c8-4a2a-a4b8-8f9a4d6bd002",
  • "ProcessingIndicator": "Accepted",
  • "RejectReason": "string"
}

Acknowledge receipt of PO line by the supplier for a previously submitted Purchase Order

A supplier can confirm a previously submitted purchase order

path Parameters
order_uuid
required
string

buyer or market place can provide a unique system id of the posted purchase order

po_line
required
string
Request Body schema: application/json
required
TransmissionReference
required
string <uuid> (TransmissionReference)
ProcessingIndicator
required
string (ProcessingIndicator)
Enum: "Accepted" "Rejected"
RejectReason
string (RejectReason)

detailed description in terms of why a request failed

Responses

Request samples

Content type
application/json
{
  • "TransmissionReference": "e63c97aa-34c8-4a2a-a4b8-8f9a4d6bd002",
  • "ProcessingIndicator": "Accepted",
  • "RejectReason": "string"
}

Confirm

Confirm a previously submitted Purchase Order

A supplier can confirm a previously submitted purchase order

path Parameters
order_uuid
required
string

buyer or market place can provide a unique system id of the posted purchase order

Request Body schema: application/json
required
required
object (BusinessPartner)
required
object (BusinessPartner)
required
object (BusinessPartner)
required
object (BusinessPartner)
object (BusinessPartner)
object (BusinessPartner)
OrderType
string (PurchaseOrderType)
Enum: "Agreement" "Assortment_Blanket" "Authority_Proceed" "Bailment" "Basic_Agreement" "Bidding" "Bill_Hold" "Blanket" "Blanket_Estimated_Quantity" "Blanket_Firm_Quantity" "Budget_Quote" "Buying" "Catalog" "Change" "Change_Contract" "Change_Release" "Close" "Confirmation" "Consignment_Issue" "Consignment_Order" "Contract" "Contract_Letter" "Contract_Notification" "Direct_Ship" "Drop_Ship" "Emergency" "Exchange" "Fabricate_Hold" "Formula_Fund" "Grant" "Ground_Aircraft_Critical" "Ground_Aircraft_Service" "Indefinite_Delivery" "Indefinite_Delivery_Quantity" "Information" "Internal_Order" "Job" "Lease" "Lease_Blanket" "Loan" "Mutually_Defined" "New" "Not_Sale" "Ordering_Agreement" "Product_Introduction" "Promotion" "Record_Service" "Release" "Release_Delivery" "Renewal" "Rental" "Reorder" "Repair_Return" "Requirements" "Resume_Order" "Retailer_Commitment" "Rush" "Sample" "Service_Order" "Special_Order" "Stand_Alone" "Standard" "Standing_Order" "Stop" "Store_Opening" "Task" "Termination" "Time_Materials" "Toll" "Unit_Down" "Unit_Exchange" "Urgent_Request" "Warranty" "Framework_Order" "Indent_Order" "Intercompany" "Shipped" "Swap"
BuyerOrderReference
required
string

Buyer's Purchase Order reference

BuyerOrderIssueDate
string <date-time> (DateTime)
SellerOrderReference
required
string

Seller's accounting reference

object (FreeTextCollection)
required
Array of objects (OrderResponseLineItem)

Responses

Request samples

Content type
application/json
{
  • "SenderParty": {
    },
  • "ReceiverParty": {
    },
  • "BuyerParty": {
    },
  • "SellerParty": {
    },
  • "BillToParty": {
    },
  • "PayerParty": {
    },
  • "OrderType": "Standard",
  • "BuyerOrderReference": "string",
  • "BuyerOrderIssueDate": "2019-08-24T14:15:22Z",
  • "SellerOrderReference": "string",
  • "OrderInstructions": {
    },
  • "lineItems": [
    ]
}

Delete

cancel a previously submitted Purchase Order

A supplier can confirm a previously submitted purchase order

path Parameters
order_uuid
required
string

buyer or market place can provide a unique system id of the posted purchase order

Request Body schema: application/json
required
Reason
required
string

Responses

Request samples

Content type
application/json
{
  • "Reason": "string"
}

Delete a PO line by the supplier for a previously submitted Purchase Order

A supplier can confirm a previously submitted purchase order

path Parameters
order_uuid
required
string

buyer or market place can provide a unique system id of the posted purchase order

po_line
required
string
Request Body schema: application/json
required
Reason
required
string

Responses

Request samples

Content type
application/json
{
  • "Reason": "string"
}

Ship

submit a shipping notification to a previously submitted purchase order

path Parameters
order_uuid
required
string

buyer or market place can provide a unique system id of the posted purchase order

Request Body schema: application/json
required
required
object (BusinessPartner)
required
object (BusinessPartner)
required
object (BusinessPartner)
required
object (BusinessPartner)
object (BusinessPartner)
object (BusinessPartner)
BuyerOrderReference
required
string

Buyer's Purchase Order reference

BuyerOrderIssueDate
string <date-time> (DateTime)
SellerOrderReference
required
string

Seller's accounting reference

object (FreeTextCollection)
required
Array of objects (ShipNoticeLineItem)

Responses

Request samples

Content type
application/json
{
  • "SenderParty": {
    },
  • "ReceiverParty": {
    },
  • "BuyerParty": {
    },
  • "SellerParty": {
    },
  • "BillToParty": {
    },
  • "PayerParty": {
    },
  • "BuyerOrderReference": "string",
  • "BuyerOrderIssueDate": "2019-08-24T14:15:22Z",
  • "SellerOrderReference": "string",
  • "ShipNoticeInstructions": {
    },
  • "lineItems": [
    ]
}

Invoice

Invoice a previously submitted Purchase Order

A supplier can invoice-flip a previously submitted purchase order

path Parameters
order_uuid
required
string

buyer or market place can provide a unique system id of the posted purchase order

Request Body schema: application/json
required
TransmissionReference
required
string <uuid> (TransmissionReference)
required
object (BusinessPartner)
required
object (BusinessPartner)
required
object (BusinessPartner)
object (BusinessPartner)
required
object (BusinessPartner)
required
object (BusinessPartner)
required
object (BusinessPartner)
object (BusinessPartner)
SupplierInvoiceReference
required
string

unique Supplier invoice reference

SupplierInvoiceIssueDate
required
string <date-time> (DateTime)
BuyerOrderReference
required
string

Buyer's Purchase Order reference

BuyerOrderIssueDate
string <date-time> (DateTime)
SellerOrderReference
required
string

Seller's accounting reference

SellerOrderIssueDate
string <date-time> (DateTime)
InvoiceType
required
string
Enum: "Debit" "Credit"
object (FreeTextCollection)
required
object
object
object
object
Array of objects (Allowance)
required
Array of objects (InvoiceLineItem)
object

Responses

Request samples

Content type
application/json
{
  • "TransmissionReference": "e63c97aa-34c8-4a2a-a4b8-8f9a4d6bd002",
  • "SenderParty": {
    },
  • "ReceiverParty": {
    },
  • "BuyerParty": {
    },
  • "SoldToParty": {
    },
  • "SellerParty": {
    },
  • "BillToParty": {
    },
  • "PayerParty": {
    },
  • "RemitToParty": {
    },
  • "SupplierInvoiceReference": "string",
  • "SupplierInvoiceIssueDate": "2019-08-24T14:15:22Z",
  • "BuyerOrderReference": "string",
  • "BuyerOrderIssueDate": "2019-08-24T14:15:22Z",
  • "SellerOrderReference": "string",
  • "SellerOrderIssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "Debit",
  • "InvoiceInstructions": {
    },
  • "TotalGrossInvoiceAmount": {
    },
  • "TotalInvoiceTaxableAmount": {
    },
  • "TotalInvoiceTaxAmount": {
    },
  • "TotalNetInvoiceAmount": {
    },
  • "headerAllowances": [
    ],
  • "lineItems": [
    ],
  • "InvoiceAttachment": {
    }
}

Documentation

post an attachment to a purchase order

path Parameters
order_uuid
required
string

buyer or market place can provide a unique system id of the posted purchase order

Request Body schema: application/json
required
FileName
string
FileType
string
Enum: "Invoice" "CoA" "CMR" "POD" "DN" "AWB" "BOL" "MSDS" "Other"
ContentType
string

content MIME type

Content
string <byte>

base64 encoded binary data

Responses

Request samples

Content type
application/json
{
  • "FileName": "string",
  • "FileType": "Invoice",
  • "ContentType": "application/pdf",
  • "Content": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNldGV0dXIgc2FkaXBzY2luZyBlbGl0ciwgc2VkIGRpYW0gbm9udW15IGVpcm1vZCB0ZW1wb3IgaW52aWR1bnQgdXQgbGFib3JlIGV0IGRvbG9yZSBtYWduYSBhbGlxdXlhbSBlcmF0LCBzZWQgZGlhbSB2b2x1cHR1YS4gQXQgdmVybyBlb3MgZXQgYWNjdXNhbSBldCBqdXN0byBkdW8gZG9sb3JlcyBldCBlYSByZWJ1bS4gU3RldCBjbGl0YSBrYXNkIGd1YmVyZ3Jlbiwgbm8gc2VhIHRha2ltYXRhIHNhbmN0dXMgZXN0IExvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0LiBMb3JlbSBpcHN1bSBkb2xvciBzaXQgYW1ldCwgY29uc2V0ZXR1ciBzYWRpcHNjaW5nIGVsaXRyLCBzZWQgZGlhbSBub251bXkgZWlybW9kIHRlbXBvciBpbnZpZHVudCB1dCBsYWJvcmUgZXQgZG9sb3JlIG1hZ25hIGFsaXF1eWFtIGVyYXQsIHNlZCBkaWFtIHZvbHVwdHVhLiBBdCB2ZXJvIGVvcyBldCBhY2N1c2FtIGV0IGp1c3RvIGR1byBkb2xvcmVzIGV0IGVhIHJlYnVtLiBTdGV0IGNsaXRhIGthc2QgZ3ViZXJncmVuLCBubyBzZWEgdGFraW1hdGEgc2FuY3R1cyBlc3QgTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQu"
}

post an attachment to a specified purchase order line

path Parameters
order_uuid
required
string

buyer or market place can provide a unique system id of the posted purchase order

po_line
required
string
Request Body schema: application/json
required
FileName
string
FileType
string
Enum: "Invoice" "CoA" "CMR" "POD" "DN" "AWB" "BOL" "MSDS" "Other"
ContentType
string

content MIME type

Content
string <byte>

base64 encoded binary data

Responses

Request samples

Content type
application/json
{
  • "FileName": "string",
  • "FileType": "Invoice",
  • "ContentType": "application/pdf",
  • "Content": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNldGV0dXIgc2FkaXBzY2luZyBlbGl0ciwgc2VkIGRpYW0gbm9udW15IGVpcm1vZCB0ZW1wb3IgaW52aWR1bnQgdXQgbGFib3JlIGV0IGRvbG9yZSBtYWduYSBhbGlxdXlhbSBlcmF0LCBzZWQgZGlhbSB2b2x1cHR1YS4gQXQgdmVybyBlb3MgZXQgYWNjdXNhbSBldCBqdXN0byBkdW8gZG9sb3JlcyBldCBlYSByZWJ1bS4gU3RldCBjbGl0YSBrYXNkIGd1YmVyZ3Jlbiwgbm8gc2VhIHRha2ltYXRhIHNhbmN0dXMgZXN0IExvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0LiBMb3JlbSBpcHN1bSBkb2xvciBzaXQgYW1ldCwgY29uc2V0ZXR1ciBzYWRpcHNjaW5nIGVsaXRyLCBzZWQgZGlhbSBub251bXkgZWlybW9kIHRlbXBvciBpbnZpZHVudCB1dCBsYWJvcmUgZXQgZG9sb3JlIG1hZ25hIGFsaXF1eWFtIGVyYXQsIHNlZCBkaWFtIHZvbHVwdHVhLiBBdCB2ZXJvIGVvcyBldCBhY2N1c2FtIGV0IGp1c3RvIGR1byBkb2xvcmVzIGV0IGVhIHJlYnVtLiBTdGV0IGNsaXRhIGthc2QgZ3ViZXJncmVuLCBubyBzZWEgdGFraW1hdGEgc2FuY3R1cyBlc3QgTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQu"
}