/shoppingCart

Retrieves a list of shopping carts. Currently available for users (CSRs) and Registered Customers. Recommended search fields are (indexed):

  • relatedParty.id (CSR Users can use this filter but the Customers already have this as a default filter)
  • validFor.endDateTime (for example for retrieving only active cart)
  • Other fields from the object schema can also be used for filter

Consult with the TMF REST API Design guidelines for filtering at page 36 of TMF630 - API Design Guidelines

Sample filter finding active carts: /shoppingCart?validFor.endDateTime=%3C%3D2021-12-14T10:37:15.002Z

OR finding active carts: /shoppingCart?validFor.endDateTime.lte=2021-12-14T10:37:15.002Z

Note: semicolon(;) symbol to separate ORING values as per TMF is not supported by AWS Gateway, please use comma(,) instead.




Depth and Expand:

Please consult with the TMF REST API Design guidelines for depth and expand at page 21 of TMF630 - API Design Guidelines


To support depth and expand, the depth directive and or an expand parameter is used in HTTP query parameters.

Depth-Query-Parameters : depth, “=”, Depth-Level

Expand-Query-Parameters : expand, “=”, Expand-Field

Depth-Level: The level upto fields should be expanded.

Expand-Field: The referenced fields to expand according to depth parameter.


The “depth” is used to expand the level of referenced (related) entities and an “expand” parameter is used to narrow down (filter) expanding of the referenced objects.


If expand is not specified then by default all the paths would be expanded.

The default value for depth directive depends on expand param. If expand parameter is set then depth is 1 otherwise depth is 0 (If depth is not specified).


In the following example the shoppingCart.cartItem is expanded up to the level of 2 as
specified by the depth parameter.


Example: /shoppingCart/3165d3c6-fcf1-465b-b850-ed4cbd6bf82e?expand=shoppingCart.cartItem&depth=2

Can be called by: user,m2m,customer,unauthenticated

Required roles: sc.view

Language
Click Try It! to start a request and see the response here!