NOD WebShop API Manual Application Programming Interface version 27.05.2019 Change log Authentication Api Reference Manufacturers Get All Get Info Product Categories Get All Get Info Products Get All Get Info Bulk Get Info Get Resealed Get Stock Get Stock Changes Full product feed Products properties Fault codes Get all: Addresses Get All Get Info Add address Update address Delete address Orders Order statuses Get All Get Info Add Order
78
Embed
N O D W e b S h o p A P I Ma n u a l€¦ · Get Info Products Get All Get Info Bulk Get Info Get Resealed Get Stock Get Stock Changes Full product feed Products properties Fault
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
NOD WebShop API Manual Application Programming Interface
version 27.05.2019
Change log
Authentication
Api Reference Manufacturers
Get All Get Info
Product Categories Get All Get Info
Products Get All Get Info Bulk Get Info Get Resealed Get Stock Get Stock Changes Full product feed Products properties
Fault codes Get all:
Addresses Get All Get Info Add address Update address Delete address
Orders Order statuses Get All Get Info Add Order
Update Order Update Status Delete Order
Invoices Get Invoices Get Info
Unpaid Invoices Get Unpaid Invoices Get Info Get Full-Feed
Exchange rates Payment Options
Get All Get Info
Payments Get All Get Info Full feed
Transport Options Get All Get Info
Discount Rules Get All
Products Filters Get All
Counties Get All
Countries Get All
Credit limit Get Info
Change log 18.12.2015 - Added vat_percent parameter to products related methods and vat_value parameter to orders related methods 02.09.2015 - Moved the functionality for invoices to the unpaid-invoices method. changed the functionality for the invoices method and now it responds with all issued invoices 07.08.2015 - Added new params for products 21.05.2013 - Added product warranty field 18.04.2013 - Added discount rules methods 16.04.2013 - Added filter by status for the method that gets all orders 26.02.2013 - Added total_price_ron to the orders methods 25.01.2013 - Added product_category_name to the products methods 22.01.2013 - Added info about transport method 19.02.2016 - Added info about transport method ‘SATURDAY_DELIVERY’ 07.04.2016 - Updated date format used in responses for several methods (orders, invoices, exchange rates, payment options, etc.) 11.04.2016 - Updated responses to match latest changes brought on several methods (orders, invoices, unpaid invoices, exchange rates, payment options, etc.) 29.06.2016 - Changed the category filter name for the get all products method 23.08.2016 - Added invoice_number parameter for orders-related methods and has_resealed parameter for products-related methods 15.06.2017 - Added X-NodWS-Navigation header for getting products based on the new categories 08.06.2018 - Added include_inactive parameter for the product categories and manufacturers methods 25.10.2018 - Added method for getting all the products properties.
Authentication
In order to use the NOD API you need an API USER and an API KEY. Each resource can handle one or more of the following HTTP methods : GET, PUT, DELETE, POST.
There are several required HTTP headers : ● Date - for example: Wed, 01 Feb 2008 12:00:00 +0000 ● X-NodWS-User - for example: zitec ● X-NodWS-Accept - xml or json ● X-NodWS-Auth - for example: 90a6d325e982f764f86a7e248edf6a660d4ee833
The value of X-NodWS-Auth header is used for request authentication and it is
constructed as following steps:
Step 1: signature_string = concatenate the following strings: HTTP verb, Query String, X-NodWS-User header value, Date header value; Step 2: X-NodWS-Auth header value = HMAC-SHA1 (API KEY, signature_string) The HMAC-SHA1 algorithm is explained in detail here.
If you do not use our PHP wrapper, see Api.php class from wrapper (Nod\Api\Methods) for examples of signature creation and message encryption.
Methods of interest: _getHttpObject, _getSignatureString, _hmacSha1.
● AuthHeaderMissing - this means that the X-NodWS-Auth header was not detected in your request
● AuthTimeDifference - this means that the time difference between the request time and our server time is greater than the allowed time. Please read the important note below.
● ClientHeaderMissing - this means that the X-NodWS-Client header was not detected in your request
● DateHeaderMissing - this means that the X-NodWS-Date header was not detected in your request
● InvalidClient - the supplied API USER is not registered within our systems ● InvalidSignature - the supplied signature in X-NodWS-Auth header is wrong or badly
formatted. Possible reasons are: ○ signature_string was not properly computed ○ HMAC algorithm was not properly calculated ○ the API KEY is invalid (badly formatted or not yet registered within our systems)
Important note: ‘signature_string’ relies on a timestamp so it is very important to have your server/system time synchronized with a NTP server.
The web service allows a time difference of maximum 60 seconds between the request date and server date.
Api Reference The following terminology will be used throughout the documentation:
● Sample Request - indicates a sample HTTP request sent to web service ● Sample Response - indicates a sample HTTP response returned by the web service ● Exception - the possible errors that the specific method can return ● Currently, the web service supports XML and JSON.
Manufacturers
Get All Notes:
● returns a list of manufacturers ● method signature GET /manufacturers/
Parameters: ?order_by={order_column} [optional] sort results by column name ?order_direction=asc|desc [optional] default value is asc ?only_resealed=1|0 [optional] get only manufacturers which have resealed products ?product_category_id[‘category’]={category_id} [optional] get only manufacturers which have products in the specified category ?include_inactive=1|0 [optional] includes manufacturers without products Sample request: GET /manufacturers/?order_by=name&order_direction=desc HTTP/1.1
Error codes: A list with available HTTP status codes that this method can return:
● 404 Not Found - Manufacturer id not found ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request
Product Categories
Get All Notes:
● returns a list of product categories ● method signature GET /product-categories/ ● when X-NodWS-Navigation header is set to “1” method returns data based on the new
product categories tree Parameters: ?order_by={order_column} [optional] sorts results by column ?order_direction=asc|desc [optional] default value for ‘order_direction’ is ‘asc’ ?include_inactive=1|0 [optional] includes categories without products Sample request: GET /product-categories/ HTTP/1.1
Error codes: A list with available HTTP status codes that this method can return:
● 404 Not Found - Category id not found ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request
Products
Get All Notes:
● returns a list of products
● the method it’s paginated, so 10 items are returned per page ● method signature GET /products/ ● when X-NodWS-Navigation header is set to “1” method returns data based on the new
product categories tree Parameters: ?search={search_term} [optional] search by product name and code ?category={product category id} [optional] filter by category id ?manufacturer={manufacturer id} [optional] filter by manufacturer id ?only_available=1|0 [optional] when set to ‘1’, it will return only products with stock value greater than 0 ?filters={array of product properties} [optional] filters by specified properties. This filter must be combined with category parameter. ?only_resealed=1|0 [optional] when set to ‘1’, it will return resealed products only ?promotion={erp_promotion_id} [optional] returns products belonging to the provided promotion only ?only_promotional=0|1 [optional] will return only products belonging to a promotion ?order_by={order_column} [optional] sort results by column ?order_direction={asc | desc} order direction (default is asc) ?count={int} number of products on page that will be returned ( default value is ‘10’) - Filters can be combined. ?add_resealed=1|0 [optional] when set to ‘1’ includes resealed products into the products list (default value is ‘0’). Sample request: GET /products/?category=123&page=2 HTTP/1.1
Error codes: A list with available HTTP status codes that this method can return:
● 404 Not Found - Product id not found ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request ● 400 Bad Request
Bulk Get Info Notes:
● returns the details of a list of products ● method signature: GET /products/products-details/{array of products} ● due to the nature of the response, the request can only be made with json content type
Error codes: A list with available HTTP status codes that this method can return:
● 404 Not Found - Product id not found ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request
Get Resealed Notes:
● returns resealed products for a product based on the product id ● method signature GET /products/{product_id}/resealed - In order for the signature request to return a valid, non-empty response, the ‘product_id’
must correspond to a product that has stock value greater than 0.
Sample request: GET /products/123/resealed HTTP/1.1
- current_page = the page number used for listing - total_pages = total number of available pages - records_per_page = total number of products on pages - id = product’s id (unique) - name = product’s name - code = product’s unique code (unique)
- description = short product description - warranty = number of warranty months for current product - warranty_type = type of warranty (DC/DL or NU(no warranty)) - product_category_id = id of the product category - product_category_name = name of the product category - manufacturer_id = id of the product manufacturer - manufacturer_name = name of the product manufacturer - min_quantity = ordered quantity for this product must be a multiple of min_quantity - stock_value = available stock - supplier_stock_value = available supplier stock - supplier_stock_delivery_date = date when supplier stock will be available - currency = product’s default currency - discount = contractual discount for current product - price = product price in default currency - catalog_price = catalog price for the current product - green_stamp_value = value of the green stamp - fault_code = fault(defect) code - defect = defect description - original_code = code of the original product - original_price = price for the original product in it’s default currency - original_currency = default currency for the original product - original_catalog_price = catalog price of the original product - promo_price = price of the resealed product with additional promotions applied.
If no other promotions are applied, this is equal to the price value - ron_price = price of the resealed product in ‘lei’ currency - ron_promo_price = price of the resealed product with additional promotions applied, in
‘lei’ currency. If no other promotions are applied, this is equal to the ron_price value - promotions = list of applied promotion id’s - pictures = product’s pictures.
These are not pictures of the resealed products and do not show any defects. They are the original product’s pictures. Error codes: A list with available HTTP status codes that this method can return:
● 404 Not Found - Product id not found ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request
Get Stock
Notes: ● returns product stock by id ● method signature GET /products/{product_id}/stock ● returns the stock in real time
- stock_value represents the available stock - supplier_stock_value represents the available supplier stock - supplier_stock_delivery_date represents the date when supplier stock will be available - reserved_stock_value represents the reserved stock - availability_days is not used and should be ignore. It is reserved for future usage.
Error codes:
A list with available HTTP status codes that this method can return:
● 404 Not Found - Product id not found ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request
Get Stock Changes Notes:
● returns stock changes after a given timestamp ● method signature GET /products/stock-changes
Parameters: ?changedfrom={timestamp} [optional] returns stock changes after the timestamp Sample request: GET /products/stock-changes?changedfrom=2017-06-27 11:33:07 HTTP/1.1
● returns all the products for a single reseller ● method signature GET /products/full-feed/
Parameters: ?format=<type> [optional] format type can be any of the following: XML, CSV or JSON. Default is set for JSON. ?only_resealed=1|0 [optional] for ‘only_resealed=1’, the request will return the resealed products only. Otherwise, the resealed products are not present in the products feed. ?include_inactive=1|0 [optional] includes or not the products that are no longer available. Sample request: GET /products/full-feed?format=json&only_resealed=1 HTTP/1.1
<defect>AMBALAJ ORIGINAL DESCHIS SI DETERIORAT, PREZINTA URME
DE UTILIZARE</defect>
<original_code>GT400</original_code>
<original_price></original_price>
<original_currency></original_currency>
<original_catalog_price></original_catalog_price>
<promo_price>58.47</promo_price>
<ron_promo_price>58.47</ron_promo_price>
<ron_price>58.47</ron_price>
<ron_catalog_price>58.47</ron_catalog_price>
<discount_rate>0</discount_rate>
</product>
...
</products>
Response interpretation:
- id = product’s id (unique) - name = product’s name - code = product’s unique code (unique) - description = short product description - warranty = number of warranty months for current product - warranty_type = type of warranty (DC/DL or NU(no warranty)) - product_category_id = id of the product category - product_category_name = name of the product category - manufacturer_id = id of the product manufacturer - manufacturer_name = name of the product manufacturer - min_quantity = ordered quantity for this product must be a multiple of min_quantity - stock_value = available stock - supplier_stock_value = available supplier stock - supplier_stock_delivery_date = date when supplier stock will be available - currency = product’s default currency - discount = contractual discount for current product - price = product price in it’s default currency - catalog_price = catalog price for the current product - green_stamp_value = value of the green stamp - fault_code = fault (defect) code - defect = description of defect - original_code = code of the original product - original_price = price for the original product in it’s default currency - original_currency = default currency for the original product - original_catalog_price = catalog price of the original product - promo_price = price of the resealed product with additional promotions applied.
If no other promotions are applied, this is equal to the price value - ron_price = price of the resealed product in ‘lei’ currency - ron_promo_price = price of the resealed product with additional promotions applied, in
‘lei’ currency. If no other promotions are applied, this is equal to the ron_price value - promotions = list of applied promotion id’s - pictures = product’s pictures.
These are not pictures of the resealed products and do not show any defects. They are the original product’s pictures.
Error codes: A list with available HTTP status codes that this method can return:
● 404 Not Found - the feed is not available in the requested format ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request
Products properties Notes:
● Returns a with all the products properties ● method signature GET /products/properties
<locality>București</locality> <street>Stradă de test</street>
<number>25D</number>
<building>55W</building>
<floor>3</floor>
<apartment>23D</apartment>
<postal_code></postal_code>
<default_delivery>0</default_delivery>
<default_billing>0</default_billing>
<delivery>1</delivery>
<billing>0</billing>
<address_type>4</address_type>
<deleted>0</deleted>
<status>2</status>
<added>2016-03-25 14:53:24.000</added>
<reason></reason>
<token></token>
<county>Bucuresti</county>
<country>Romania</country>
<office>0</office>
</address>
Error codes: A list with available HTTP status codes that this method can return:
● 500 Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request
● 404 Not Found - Address Id not found
Add address Notes:
● adds a new address ● method signature POST /addresses/ ● required fields: country_id, county_id, locality, street, number, address_type ● all other fields are optional but even if left empty need be in the request: building, floor,
apartment, default_billing, default_delivery, postal_code ● on success the api will return the id of the created entity ● address_type is a bitmask with the following values:
○ 2 - Billing address ○ 4 - Shipping address
In order to add an address that will be used for both billing and shipping, address_type needs to be 6 (Billing + Shipping -> 2 + 4 = 6). Sample request POST /addresses/ HTTP/1.1
Error codes: A list with available HTTP status codes that this method can return:
● 500 Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request
● 400 Bad Request - Invalid or empty field ● 404 Not Found - Address Id not found
Delete address Aceasta metoda nu mai exista.
Orders
Order statuses
● NOT_ACCEPTED - order was rejected due to an error. In most cases, The API will provide additional error details.
● STOCK_RESERVATION - The products in the order are reserved but the order is not going to be processed until the order is confirmed by using the update-status method. A reservation will be deleted by the system after 3 days and will receive an EXPIRED status.
● PROCESSING - the order was recorded and a NOD employee is processing it. ● DELIVERY_READY - the order is picked from our warehouse and is waiting for the
courier or for the customer to pick it up.
● BILLED - the order has at least one invoice assigned to it. ● DELIVERED - the order was fulfilled, with all the items delivered. ● CREDIT_LIMIT - the order is recorded but the reseller has maxed out its credit limit and
needs to contact his Account Manager. ● OUTSTANDING_BALANCE - the order is recorded but the reseller has outstanding
balance and needs to contact his Account Manager. ● DELETED - the order is recorded but it was deleted either by the reseller or by the
Account Manager. ● EXPIRED - this status is given to a stock reservation after a 3 days period.
Get All Notes:
● returns order history for orders placed using the Webshop or the Webshop API. It will not return the orders placed with the Account Manager.
● method signature GET /orders/ Parameters:
● ?date_start={date start}&date_end={date end} [optional] accepted date format: yyyy-MM-dd
● ?page={current_page} [optional] displays a specified page ● ?status={status_name} [optional] sorts results by status ● ?order_by={order_column} [optional] sorts results by requested column. Default is
‘?order_by=date’ ● ?order_direction=asc|desc [optional] Default is ‘?order_direction=desc’ - Filters can be combined.
Error codes: A list with available HTTP status codes that this method can return:
● 404 Not Found - Order not found ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request
Add Order Notes:
● adds a new order ● method signature POST /orders/ ● The ‘SATURDAY_DELIVERY’ transport option is available only on fridays. If selected,
your products will be delivered next saturday. Parameters
● delivery_address [required] valid delivery address id ● payment_option [required] valid payment option id ● transport_option [required] valid transport option id ● items [required] a list of items to be added ● all_or_none [optional] default is ‘0’, order is saved if all items are valid ● only_stock_reservation [optional] default is ‘0’. For ‘only_stock_reservation=1’, the order
is saved with ‘STOCK_RESERVATION’ status, meaning that the stock is reserved. Invoices are not generated.
● emails [optional] A list of emails to send notifications. Field is ignored when default address is selected on Configurations > Email alerts page
● comment [optional] Parameter used for adding a comment for the order Sample request POST /orders/ HTTP/1.1
<message>Comanda dvs. poate fi blocata de la livrare
datorita faptului ca figurati in sistemul nostru cu sold scadent. In
cazul in care statusul ei nu se schimba dupa cateva ore, va rugam
luati legatura cu managerul de cont pentru a o debloca.
Multumim!</message>
</warning>
</warnings>
</result>
Sample error responses:
❖ No items
<error>
<code>noItems</code>
<message>Order has no items</message>
</error>
❖ Invalid items ● all_or_none = 1 ● 400 Bad Request status returned
<result>
<items>
<item>
<data>
<id>083cc30e6d408c1b155e70dasa05b29c17</id>
<quantity>3</quantity>
</data>
<errors>
<id>
<NonExistentProduct>Non-existent product
requested for order</NonExistentProduct>
</id>
</errors>
</item>
<item>
<data>
<id>72e0dbbf910bd0a5fgda761aab639602a36</id>
<quantity>2</quantity>
</data>
<errors>
<id>
<NonExistentProduct>Non-existent product
requested for order</NonExistentProduct>
</id>
</errors>
</item>
</items>
</result>
❖ Insufficient stock ● 400 Bad Request status returned ● The available stock value is included in response
<result>
<items>
<item>
<data>
<id>083cc30e6d408c1b155e70da05b29c17</id>
<quantity>3</quantity>
<real_stock>1</real_stock>
</data>
<errors>
<error>
<result>Insuficient stock for product
083cc30e6d408c1b155e70da05b29c17</result>
</error>
</errors>
</item>
<item>
<data>
<id>72e0dbbf910bd0a5a761aab639602a36</id>
<quantity>2</quantity>
<real_stock>1</real_stock>
</data>
<errors>
<error>
<result>Insuficient stock for product
72e0dbbf910bd0a5a761aab639602a36</result>
</error>
</errors>
</item>
</items>
</result>
Error codes: A list with available HTTP status codes that this method can return:
● 400 Bad Request - invalid items ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request
Update Order Notes:
● updates an order ● method signature POST /orders/{order_id} ● if a product’s quantity is set to 0, the product is removed from order ● at least one product must remain on an order ● maximum quantity for a product is current quantity on order plus the available real time
stock value ● an order can be updated only if its current status is STOCK_RESERVATION
Parameters ?delivery_address [optional] valid delivery address id ?payment_option [optional] valid payment option id ?transport_option [optional] valid transport option id ?billing_address [optional] valid billing address id ?items [optional] a list of new products or new quantity for existing products Sample request POST /orders/123456789 HTTP/1.1
A list with available HTTP status codes that this method can return:
● 500 Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request
● 404 Not Found - Order Id not found
Invoices
Get Invoices Notes:
● returns a list of invoices ● the method is paginated (20 items per page) ● method signature: GET /invoices/
Parameters: ?issue_date_start [optional] filters the invoices created after a certain date ?issue_date_end [optional] filters the invoices created before a certain date ?invoice_date_start [optional] filters the invoices that have a date after the provided date ?invoice_date_end [optional] filters the invoices that have a date before the provided date ?invoice_number [optional] filters invoices based on invoice number Sample request GET /invoices?sold=1&series=NOD&number=123456789&page=1 HTTP/1.1
Host: api.b2b.nod.ro
Date: Thu, 17 Feb 2015 14:52:54 GMT
X-NodWS-User: zitec
X-NodWS-Accept: xml
X-NodWS-Auth: 90a6d325e982f764f86a7e248edf6a660d4ee833 Sample response HTTP/1.1 200 OK
Error codes A list with available HTTP status codes that this method can return:
● 500 Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request
Get Info This method also accepts the “pdf” value for the X-NodWS-Accept header. If the accept value is pdf the API will respond with a base64 encoded pdf file. Notes:
● returns invoice info by id ● method signature GET /invoices/{invoice_id}
<transport_value>Ridicare de la dep</transport_value>
<sales_document_type/>
<order_number/>
<delivery/>
</invoice_header>
<items>
<item>
<code>RX-630SS</code>
<pos_num>000020</pos_num>
<type/>
<quantity>-1.0</quantity>
<net_value>-162.0</net_value>
<vat_value>-38.88</vat_value>
<description/>
<quantity_unit>BUC</quantity_unit>
<name>PSU RAIDMAX 630W RX-630SS</name>
<unit_price>162.0</unit_price>
<position_type>G2N</position_type>
<client_material/>
<denln>37</denln>
<retur/>
<free/>
</item>
<item>
<code>RX-630SS</code>
<pos_num>000030</pos_num>
<type/>
<quantity>1.0</quantity>
<net_value>150.0</net_value>
<vat_value>36.0</vat_value>
<description/>
<quantity_unit>BUC</quantity_unit>
<name>PSU RAIDMAX 630W RX-630SS</name>
<unit_price>150.0</unit_price>
<position_type>L2N</position_type>
<client_material/>
<denln>37</denln>
<retur/>
<free/>
</item>
</items>
</invoice>
Error codes: A list with available HTTP status codes that this method can return:
● 404 Not Found - Invoice id not found ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request
Unpaid Invoices
Get Unpaid Invoices Notes:
● returns a list of unpaid invoices ● the method is paginated, so 25 items are returned per page ● method signature: GET /unpaid-invoices/
Parameters: ?date_created_start [optional] will filter the invoices created after a certain date ?date_created_end [optional] will filter the invoices created before a certain date ?due_date_start [optional] will filter the invoices that have a due date after a certain date ?due_date_end [optional] will filter the invoices that have a due date before a certain date ?invoice_series [optional] searches for invoices with a certain series ?invoice_number [optional] searches for invoices with a certain number ?order_by={order_column} sorts results by requested column ?order_direction=asc|desc [optional] default value is asc ?page=2 - this can apply for all of the above ?overdue=1 - returns all unpaid invoices
- Filters can be combined. Sample request
GET /unpaid-invoices?sold=1&series=NOD&number=123456789&page=1
HTTP/1.1
Host: api.b2b.nod.ro
Date: Thu, 17 Feb 2015 14:52:54 GMT
X-NodWS-User: zitec
X-NodWS-Accept: xml
X-NodWS-Auth: 90a6d325e982f764f86a7e248edf6a660d4ee833 Sample response: HTTP/1.1 200 OK
Error codes: A list with available HTTP status codes that this method can return:
● 404 Not Found - Payment option id not found ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request
Payments
Get All
Notes: ● returns a list of all payments ● method signature GET /payments/
Parameters: ?order_by={order_column} [optional] sorts results by column ?order_direction=asc|desc [optional] default value is ‘asc’ ?date_start={Y-m-d}&date_end={Y-m-d} [optional] interval search by date ?amount_start={value}&amount_end={value} [optional] interval search by amount ?source_iban [optional] search by iban source ?dest_iban [optional] search by destination iban
- Filters can be combined. Deprecated (or obsolute) parameters: ?payment_details - no effect (used to search by payment details with “LIKE” rule) ?payment_method - no effect (used to search by payment method) ?serial_number - no effect (used to return a payment by the provided serial number) Sample request GET /payments/ HTTP/1.1
Error codes: A list with available HTTP status codes that this method can return:
● 500 Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request
Transport Options
Get All Notes:
● returns a list of available transport options ● method signature GET /transport-options/ ● The transport option called ‘SATURDAY_DELIVERY’ is available only on fridays. If you
select this option, your products will be delivered next saturday. Parameters: ?order_by={order_column} [optional] sort results by column ?order_direction=asc|desc [optional] default value is ‘asc’ Sample request GET /transport-options/?order_by=code&order_direction=desc HTTP/1.1
</transport_option> Error codes: A list with available HTTP status codes that this method can return:
● 404 Not Found - Payment option id not found ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request
Discount Rules
Get All Notes:
● returns a list of discount rules ● method signature GET /discounts/
Parameters: ?manufacturer_id={manufacturer_id} searches for a specified manufacturer id ?product_category_id={product_category_id} searches for a specified category id ?page={current_page} displays a certain page ?order_by={order_column} [optional] sorts results by column ?order_direction=asc|desc [optional] default value is ‘asc’ Sample request GET /discounts/ HTTP/1.1
Error codes: A list with available HTTP status codes that this method can return:
● 500 Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request
Products Filters
Get All Notes:
● This method return the product filters and manufacturers ● Method signature GET /products-filters
Parameters:
● ?category={category_id} [optional] returns product filters and manufacturers for a specified category
● ?filters={array of product properties} [optional] return the products filters by the specified properties. This filter must be combined with category parameter.
Sample request: GET /products-filters/?category=23&filters[Buffer][]=64MB HTTP/1.1
A list with available HTTP status codes that this method can return: ● 500 Internal Server Error - The server encountered an unexpected condition which
prevented it from fulfilling the request.
Counties
Get All Notes:
● Returns a list of counties ● Method signature GET /counties
Error codes: A list of available error codes that this method returns:
● 500 Internal server error
Credit limit
Get Info Notes:
● returns the total credit limit and the remaining credit ● required field: amount - the value of a purchase ● method signature: GET /credit-limit?amount={amount}
Sample request: GET /credit-limit?amount=14 HTTP/1.1
Error codes: A list of available error codes that this method returns:
● 500 Internal server error ● 404 Not Found - the requested amount was not found ● 400 Bad Request - the value of the amount parameter is not a numerical value