Creating a cart
The request body for creating a cart contains the name of the cart to be created, assigned to the variable “cartName”.
URL of the POST method: https://api.itscope.com/2.1/business/carts
Example:
POST https://api.itscope.com/2.1/business/carts
{
"cartName": "Cart for Thomas"
}Editing (renaming) a cart
The request body is the same as when creating a cart. Therefore, the new name of the cart is assigned to the variable “cartName”.
The cart to be edited is specified by the cartId, which is generated while creating a cart.
URL of the PUT method: https://api.itscope.com/2.1/business/carts/<cartId>
Example:
PUT https://api.itscope.com/2.1/business/carts/640b6b1e-01fa-423e-b072-8b7dca155c2e
{
"cartName": "Shopping by Thomas"
}Deleting a cart
The cart to be deleted is specified by the cartId.
URL of the DELETE method: https://api.itscope.com/2.1/business/carts/<cartId>
Example:
DELETE https://api.itscope.com/2.1/business/carts/640b6b1e-01fa-423e-b072-8b7dca155c2e
Adding products to a cart
Add products to existing shopping cart
The request body for adding products to a cart contains the ‘cartLineItem’ object.
The required variables can be looked up in the metadata topic.
The cartId specifies the cart where products should be added to.
URL of the POST method: https://api.itscope.com/2.1/business/carts/<cartId>/cartlineitems
Example 1:
We want to add the product with the PUID 1559972000 to our cart, with a quantity of five and from the supplier Ingram Micro Germany. Ingram Germany has the supplier ID 14 and the product has the Ingram item number ‘9432GFW’. We do not set an end customer order reference or addresses, as we do not need the former and the latter is loaded from ITscope.
POST https://api.itscope.com/2.1/business/carts/640b6b1e-01fa-423e-b072-8b7dca155c2e/cartlineitems
{
"cartLineItem": [
{
"puid": 1559972000,
"supplierId": 14,
"supplierItemId": "9432GFW",
"quantity": 5,
"comment": "For the printer in the southern office wing"
}
]
}Example 2:
Again, we want to add the product with the PUID 1559972000 to the shopping cart five times. This time we are procuring the product for one of our customers, whose order reference is AB12345. The order is to be sent to a specific address, which is why a delivery address (delivery) and an end customer address (customer) have been set. In addition to the delivery address (delivery), an invoice address (invoice_recipient) and end customer address (customer) can also be set.
POST https://api.itscope.com/2.1/business/carts/640b6b1e-01fa-423e-b072-8b7dca155c2e/cartlineitems
{
"cartLineItem": [
{
"puid": 1559972000,
"supplierId": 14,
"supplierItemId": "9432GFW",
"quantity": 5,
"comment": "Für den Drucker im Büro Süd",
"customerOrderReference": "AB12345",
"referencedAddresses":
{
"referencedAddress": [
{
"addressType": "delivery",
"name": "Max Mustermann",
"street": "Musterstr. 5",
"zipCode": "12345",
"city": "Karlsruhe",
"countryCoded": "DE",
"contactEmail": "Max@Mustermann.de"
},
{
"addressType": "customer",
"name": "Peter Mustermann",
"name2": "Addresszusatz1",
"name3": "Addresszusatz2",
"street": "Endkundenstrasse 5",
"zipCode": "12345",
"city": "Karlsruhe",
"countryCoded": "DE",
"contactFirstName": "Peter"
"contactLastName": "Mustermann"
"contactEmail": "peter@Mustermann.de"
}
]
}
}
]
}Additional optimization of the shopping cart when adding products
A request parameter optimizationStrategy can be used to optimize the shopping cart by transmitting an optimization strategy. The result of this method is then the optimized shopping cart, including assignment of the individual items to a suitable source of supply, depending on the optimization strategy.
Url POST-Method: https://api.itscope.com/2.1/business/carts/<cartId>/cartlineitems?optimisationStrategy=minprice
This parameter can have the following values
- manual: the arrangement of the sources of supply as it was initially created by adding products to the shopping cart. Items that have been moved into the shopping cart manually are included in the ‘Manual’ arrangement.
- minprice: this optimisation attempts to assign all items from the order to suppliers that are part of your partner network. Items that are not available from your partners remain with their manually assigned supplier(s).
- minpricepartner this optimisation distributes items from the order irrespective of supplier partner status, to achieve the best total cost for the shopping cart.
- minsuppliers: this optimisation variant reduces the number of different suppliers to a minimum. Partners in your network are preferred, but non-partners are also considered as a backup option.
Optimize products in an existing shopping cart
If a shopping cart has already been created, it can be explicitly optimized later using this method
URL PUT-Method: https://api.itscope.com/2.1/business/carts/<cartId>/optimise?optimisationStrategy=minprice
A request parameter optimizationStrategy can be used to optimize the shopping cart by transmitting an optimization strategy. The result of this method is then the optimized shopping cart, including assignment of the individual items to a suitable source of supply, depending on the optimization strategy.
This parameter can have the following values
- manual: the arrangement of the sources of supply as it was initially created by adding products to the shopping cart. Items that have been moved into the shopping cart manually are included in the ‘Manual’ arrangement.
- minprice: this optimisation attempts to assign all items from the order to suppliers that are part of your partner network. Items that are not available from your partners remain with their manually assigned supplier(s).
- minpricepartner this optimisation distributes items from the order irrespective of supplier partner status, to achieve the best total cost for the shopping cart.
- minsuppliers: this optimisation variant reduces the number of different suppliers to a minimum. Partners in your network are preferred, but non-partners are also considered as a backup option.
Removing products from a cart
The product to be removed is specified using the lineItemId. The cartId is also required in order to locate the cart from which the product is to be removed.
URL of the DELETE method: https://api.itscope.com/2.1/business/carts/<cartId>/cartlineitems/<lineitemId>
Example:
DELETE https://api.itscope.com/2.1/business/carts/640b6b1e-01fa-423e-b072-8b7dca155c2e/cartlineitems/9f8d78d5-118e-4f9d-9a98-2e6ec551c9b1
Showing a cart
Fetching a cart requires the cartId. The output will be in cart format.
URL of the GET method: https://api.itscope.com/2.1/business/carts/<cartId>/cart.json*
* or cart.xml
Example:
GET https://api.itscope.com/2.1/business/carts/640b6b1e-01fa-423e-b072-8b7dca155c2e/cart.json
Listing all carts
Lists all carts. The output will be in shopping cart format.
URL of the GET method: https://api.itscope.com/2.1/business/carts/cart.json*
* or cart.xml
Example:
GET https://api.itscope.com/2.1/business/carts/cart.json