Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following table lists available REST API methods that a third party service can invoke. URL's must start with https://po.raleyapps.com/ and end with the URL suffix as indicated in the table below


MethodURL suffixDescriptionDescripctionExample Response
GET
api/v1/external/get-suppliers
Returns list of suppliers configured for given installation of Raley PO. Archived suppliers are not returned

[
{
"id": 291,
"name": "Test supplier",
"phone": "555 5555",
"email": "contact@supplier.com",
"address": "Address of supplier",
"notes": "",
"paymentDetails": "DE72392732643627",
"taxNo": "DE8473273",
"contact": "",
"terms": "NET30",
"archived": false
}
]

GET
api/v1/external/get-taxes
Returns list of taxes configured for given installation of Raley PO. Archived taxes are not returned

[
{
"id": 120,
"name": "Default tax",
"value": "20.0",
"isDefault": true,
"archived": false,
"companyId": 217
}
]

GET
api/v1/external/find-products-by-sku?sku=SKU_VALUE

Finds and returns list of product that match by given SKU identifier SKU_VALUE. Both, active and archived products can be returned.

This methods returns HTTP 404 if no products are found. 

[
 {
   "id": 1413,
   "sku": "abc",
   "description": "Mazutka",
   "unitPrice": 5323.0,
   "supplierId": 291,
   "taxRate": {
   "id": 120,
   "name": "Default tax",
   "value": "20.0",
   "isDefault": true,
   "archived": false,
   "companyId": 217
 },
 "active": true,
 "approved": true,
 "productApprovalType": null
}
]

POST
api/v1/external/create-product

Creates a product with given parameters passed as JSON array. 

sku - business identifier used to identify products in your system

unitPrice - product price including applicable taxRate

supplierId - id of supplier that offers this product

taxRate - object containing an "id" field which corresponds to applicable tax rate

active - whether the product should be active or archived

approved - true when you're not using product approval process. Otherwise false.

productApprovalType - null if you're not using the product approval process, otherwise a JSON object with mandatory "id" field which corresponds to the product approval type ID.

On successful invocation, the method will return newly created product data in JSON format.

{
"sku": "YOUR BUSINESS DENTIFIER",
"description": "This is a brand new product that we add to Raley",
"unitPrice": 199.99,
"supplierId": 291,
"taxRate": {
"id": 120
},
"active": true,
"approved": true,
"productApprovalType": null
}

PUT
api/v1/external/update-product

Updates a product with given id to the values set in product fields. 

The semantic of he fields is the same as in create-product method.

On successful invocation, the method will return updated product data in JSON format

{
"id": 1733,
"sku": "YOUR BUSINESS DENTIFIER 2",
"description": "This is a brand new product that we add to Raley 22",
"unitPrice": 199.99,
"supplierId": 291,
"taxRate": {
"id": 120
},
"active": true,
"approved": true,
"productApprovalType": null
}