ShipServ's Order management APIs give Buyers and Suppliers a simple and secure way to connect and integrate the flow of trading documents from Requisitions to Purchase Order Confirmations.
References
Whether you want to know how to perform a request or what attributes you can look for, we have a more detailed page for you to read. Please click here.
As a Buyer or a Supplier, you can download the list of Requisitions/ RequestForQuotes/ Quotes/ PurchaseOrders/ PurchaseOrderConfirmation.
Using curl
curl --location --request GET 'https://test.shipserv.com/api/order-management/documents?type=RequestForQuote' \
--header 'Authorization: Bearer khFkepBkjlqbkUlrlA1TUVv71n1lK8cY'
And you should get a response which should look like this:
{
"content": [
{
"id": "2de08e79-ff4f-40bb-9ba2-b8bebbff9a70",
"buyerTnId": 100004,
"supplierTnId": 300371,
"priority": "Medium",
"subject": "TESTING NEW ORDER MANAGEMENT 0001 W/ATT",
"referenceNumber": "ORD_MGT_TEST_DEV_0001",
"status": "Unactioned",
"createdDate": "2021-02-09T11:20:31.085Z",
"submittedDate": "2021-02-09T11:20:31.085Z",
"exported": false
},
{
"id": "da48be80-7ca5-400b-a27b-840f617d3aa7",
"buyerTnId": 100004,
"supplierTnId": 300371,
"priority": "Medium",
"subject": "TESTING NEW ORDER MANAGEMENT 0001 W/ATT",
"referenceNumber": "ORD_MGT_TEST_DEV_0001",
"status": "Unactioned",
"createdDate": "2021-02-09T10:57:23.515Z",
"submittedDate": "2021-02-09T10:57:23.515Z",
"exported": false
},
{
"id": "f35e9c6f-ddf6-4611-ac5f-bc87084a6f21",
"buyerTnId": 100004,
"supplierTnId": 300371,
"priority": "Medium",
"subject": "TESTING NEW ORDER MANAGEMENT 0001 W/ATT",
"referenceNumber": "ORD_MGT_TEST_DEV_0001",
"status": "Lapsed",
"adviseBeforeDate": "2021-02-09T11:22:14.038Z",
"createdDate": "2021-02-09T10:55:24.951Z",
"submittedDate": "2021-02-09T10:55:24.951Z",
"exported": false
},
{
"id": "206c89c7-f264-4016-814a-5808c6005b08",
"buyerTnId": 100004,
"supplierTnId": 300371,
"priority": "Medium",
"subject": "TESTING NEW ORDER MANAGEMENT 0001",
"referenceNumber": "ORD_MGT_TEST_DEV_0001",
"status": "Unactioned",
"createdDate": "2021-02-09T10:37:32.752Z",
"submittedDate": "2021-02-09T10:37:32.752Z",
"exported": false
}
],
"pageNumber": "1",
"pageSize": "20",
"numberOfElements": 5
}
As a buyer or a supplier you can get a specific Requisition/ RequestForQuote/ Quote/ PurchaseOrder/ PurchaseOrderConfirmation using the document ID:
Using curl
curl --location --request GET 'https://test.shipserv.com/api/order-management/documents/2078916b-9829-4ecd-9835-7c8ca2fd217e' \
--header 'Authorization: Bearer lcN39C7PW49cs2FGToNtnzhLzJlOUN4j'
And you should get a response which should look like this:
{
"buyer": {
"tnId": 100004,
"name": "Aus API Test Buyer"
},
"supplier": {
"tnId": 300371
},
"createdDate": "2021-02-09T11:20:31.085Z",
"currencyInstructions": "string",
"deliveryTerms": {
"code": "string"
},
"packagingInstructions": "PackagingInstructions String",
"paymentTerms": "RMT 90 DAYS",
"priority": "Medium",
"referenceNumber": "ORD_MGT_TEST_DEV_0001",
"status": "Submitted",
"subject": "TESTING NEW ORDER MANAGEMENT 0001 W/ATT",
"submittedDate": "2021-02-09T11:20:31.085Z",
"taxStatus": "Exempt",
"termsAndConditions": "TermsAndConditions testing line here.",
"transportMode": "Road",
"lineItems": [
{
"number": 1,
"comment": "GREEN LIGHT",
"description": "[EA] BLOCK,GREEN LIGHT,120V \r\r\nMFG: SCHNEIDER ELECTRIC CO \r\r\nPart NO: ZALVG3 \r\r\nCage 0EAT8 \r\r\n\r\r\n***FOR OFFICE USE ONLY*** \r\r\nTRACKING NO: N105469307S072 \r\r\nNIIN: \r\r\nRIC/APL: ",
"quality": "Low",
"quantity": 5.0,
"totalCost": 10.0,
"unitPrice": 2.0,
"unitOfMeasure": "SET",
"partIdentification": [
{
"typeCode": "Other"
}
],
"id": "fb1ba166-f172-4fb8-a684-205f837b8a5b",
"status": "Original"
},
{
"number": 2,
"comment": "SF19-0626 SHIP HOT",
"description": "FREIGHT, PACKING AND HANDLING",
"quality": "Low",
"quantity": 5.0,
"totalCost": 100.0,
"unitPrice": 20.0,
"unitOfMeasure": "PCE",
"partIdentification": [
{
"typeCode": "Other"
}
],
"id": "39fe5089-172b-4b1b-9fe7-bcff55ad6938",
"status": "Original"
},
{
"number": 3,
"comment": "SF19-0626 SHIP HOT",
"description": "FREIGHT, PACKING AND HANDLING",
"quality": "Low",
"quantity": 5.0,
"totalCost": 100.0,
"unitPrice": 20.0,
"unitOfMeasure": "PCE",
"partIdentification": [
{
"typeCode": "Other"
}
],
"id": "486669d0-e274-44ba-ae83-eafc01086454",
"status": "Original"
},
{
"number": 4,
"comment": "SF19-0626 SHIP HOT",
"description": "FREIGHT, PACKING AND HANDLING",
"quality": "Low",
"quantity": 5.0,
"totalCost": 50.0,
"unitPrice": 10.0,
"unitOfMeasure": "PCE",
"partIdentification": [
{
"typeCode": "Other"
}
],
"id": "ffdc9d10-f275-4e7b-b3bb-d189269d7f46",
"status": "Original"
}
],
"attachments": [
{
"name": "RFQ.txt",
"type": "txt",
"size": 7077,
"id": "cc42dfcf-09ed-4aae-9348-bdb865e49728"
}
],
"id": "2de08e79-ff4f-40bb-9ba2-b8bebbff9a70",
"type": "RequestForQuote",
"freightForwarder": {
"name": "Fuji Trading (Singapore) Pte Ltd",
"identification": "",
"address": {
"line1": "24 Chia Ping Road",
"city": "Singapore",
"stateOrProvince": "Singapore",
"country": {
"code": "SG"
},
"postalCode": "619976"
},
"contact": {
"name": "Chua Weiliang",
"mobile": "+65 6265 0443",
"telephone": "+65 6305 6813",
"email": "test@shipserv.com"
}
},
"billing": {
"name": "",
"identification": "",
"address": {
"line1": "Testing Street Address 1Testing Street Address 2",
"city": "Manila",
"stateOrProvince": "PH",
"country": {
"code": "PH"
},
"postalCode": "12345"
},
"contact": {
"name": "Wil Testing Name",
"mobile": "+12345678",
"telephone": "+1234567890",
"email": "test@shipserv"
}
},
"consignee": {
"name": "HORIZON AIR FREIGHT (SHIPHOT)",
"identification": "",
"address": {
"line1": "152 15 ROCKAWAY BLVD ( TN91114 ), JAMAICA, NY 11434",
"city": "",
"stateOrProvince": "PH",
"country": {
"code": "US"
},
"postalCode": "12334"
},
"contact": {
"name": "Steve Liedts",
"jobTitle": "Purchasing",
"mobile": "+65 0032 3 2700180",
"telephone": "718-528-3800",
"email": "test@shipserv.com"
}
},
"portAgent": {
"name": "",
"address": {
"line1": "",
"city": "",
"stateOrProvince": "",
"country": {
"code": ""
},
"postalCode": ""
},
"contact": {
"name": "",
"mobile": "",
"telephone": "",
"email": ""
}
},
"replaced": false
}
As a Buyer, you can create and submit a new Requisition, RequestForQuote and PurchaseOrder and submit them to your Suppliers.
As a Supplier, you respond back to your buyers by creating a Acknowledge response, a Quote and a PurchaseOrderConfirmation.
Using curl
curl --location --request POST 'https://test.shipserv.com/api/order-management/documents' \
--header 'Authorization: Bearer eNm8SUkFYtpfR3S6DOtuNe6CgolBXdnC' \
--header 'Content-Type: application/json' \
--data-raw '{
"buyer": {
"tnId": 10510,
"name": "Aus API Test Buyer"
},
"supplier": {
"tnId": 84623,
"name": "Aus API Test Supplier"
},
"createdDate": "2021-04-04T11:57:28.214Z",
"priority": "Low",
"referenceNumber": "Test8",
"subject": "03/09/2021",
"submittedDate": "2021-04-04T11:57:28.214Z",
"lineItems": [
{
"number": 1,
"description": "Beef Shank",
"quantity": 200.0,
"totalCost": 0.0,
"unitPrice": 0.0,
"unitOfMeasure": "KGM",
"discountCost": 0.0,
"discountPercentage": 0.0,
"status": "Original"
}
],
"type": "RequestForQuote",
"billing": {
"address": {
"line1": "18/F Wynsum Corporate Plaza",
"line2": "F. Ortigas",
"city": "Pasig City",
"stateOrProvince": " ",
"country": {
"code": "PH",
"name": "Philippines"
},
"postalCode": "1000"
}
},
"replaced": false,
"attachments": [
{
"name": "TEST Attachment.pdf",
"type": "pdf",
"size": 161622,
"base64String": "JVBERi0xLjcKCjQgMCBvYmoKKElkZW50aXR5KQ"
}
]
}'
You should receive a response as below:
{
"code": "success",
"message": "document created",
"data": {
"id": "2b44849b-d96f-4a36-88d9-62dc6bd0e4cd",
"correlationId": "bdf8e7f6-8c27-427c-b04c-6f12436c740c"
}
}
As a Supplier, you can send an Acknowledge response to your buyers once you have successfully downloaded the RequestForQuote and/or PurchaseOrders in to your system.
Using curl
curl --location --request POST 'https://test.shipserv.com/api/order-management/documents/80ecebea-8033-4730-8fdc-1af49822edf7/acknowledge' \
--header 'Authorization: Bearer lcN39C7PW49cs2FGToNtnzhLzJlOUN4j'
You should receive a response as below:
{
"code": "Success",
"message": "test message",
"data": {
"Id": "6b799448-3bc0-49db-9a46-fa72ad45b40b"
"correlationId": "bdf8e7f6-8c27-427c-b04c-6f12436c740c"
}
}
As a Supplier, you can decline a RequestForQuote and PurchaseOrder document and POST a response via ShipServ API.
Using curl
curl --location --request POST 'https://test.shipserv.com/api/order-management/documents/80ecebea-8033-4730-8fdc-1af49822edf7/decline' \
--header 'Authorization: Bearer JplMgssae5Qrw5mHtHE1c1ehiTXSAp2N' \
--header 'Content-Type: application/json' \
--data-raw '{
{ "reason": "PartOutOfStock",
"reasonText": "test text"}'
You should receive a response as below:
{
"code": "Success",
"message": "test message",
"data": {
"Id": "6b799448-3bc0-49db-9a46-fa72ad45b40b"
"correlationId": "bdf8e7f6-8c27-427c-b04c-6f12436c740c"
}
}
As a Buyer you can mark a Quote and a PurchaseOrderConfirmation as exported by specifying the document id in the parameters.
As a Supplier you can mark a RequestForQuote and a PurchaseOrder as exported by specifying the document id in the parameters.
Using curl
curl --location --request POST 'https://test.shipserv.com/api/order-management/documents/80ecebea-8033-4730-8fdc-1af49822edf7/mark-as-exported' \
--header 'Authorization: Bearer lcN39C7PW49cs2FGToNtnzhLzJlOUN4j'
You should receive a response as below:
{
"code": "Success",
"message": "test message",
"data": {
"Id": "6b799448-3bc0-49db-9a46-fa72ad45b40b"
"correlationId": "bdf8e7f6-8c27-427c-b04c-6f12436c740c"
}