Get all carts
get
/fscmRestApi/resources/11.13.18.05/transactionReferenceContexts/{transactionReferenceContextsUniqID}/child/carts
Request
Path Parameters
-
transactionReferenceContextsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Transaction Reference Contexts resource and used to uniquely identify an instance of Transaction Reference Contexts. The client should not generate the hash key value. Instead, the client should query on the Transaction Reference Contexts collection resource in order to navigate to a specific instance of Transaction Reference Contexts to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds all carts that match the primary key criteria specified.
Finder Variables:- CartHeaderId; integer; Unique identifier for the cart.
- PromotionFinder: Finds all carts that match the promotion finder criteria.
Finder Variables:- PromoCode; string; Promotion code for the cart.
- PrimaryKey: Finds all carts that match the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CartHeaderId; integer; The unique identifier of the shopping cart header.
- CountryCode; string; A short alphabetic code representing the country that is used as the default address.
- CurrencyCode; string; The currency code associated with a cart.
- CurrencySymbol; string; The currency symbol associated with a cart.
- PromotionCode; string; The promotion code applied to the cart.
- TotalAmount; number; The numeric value of the total amount charge of a cart.
- TotalDiscountAmount; number; The numeric value of the total discount amount given for a cart.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : transactionReferenceContexts-carts
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : transactionReferenceContexts-carts-item-response
Type:
Show Source
object
-
CartHeaderId: integer
(int64)
Title:
Cart Header ID
Read Only:true
The unique identifier of the shopping cart header. -
CountryCode: string
A short alphabetic code representing the country that is used as the default address.
-
CurrencyCode: string
Title:
Currency Code
Read Only:true
The currency code associated with a cart. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The currency symbol associated with a cart. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
miscellaneousFeeItems: array
Miscellaneous Fee Items
Title:
Miscellaneous Fee Items
The miscellaneous fee items resource provides a list of miscellaneous fee items present in the cart. -
PromotionCode: string
Title:
Promotion Code
The promotion code applied to the cart. -
scheduledCourseItems: array
Scheduled Course Items
Title:
Scheduled Course Items
The scheduled course items resource provides a list of scheduled course items present in the cart. -
TotalAmount: number
Title:
Total Amount
Read Only:true
The numeric value of the total amount charge of a cart. -
TotalDiscountAmount: number
Title:
Total Discount Amount
Read Only:true
The numeric value of the total discount amount given for a cart.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Miscellaneous Fee Items
Type:
array
Title:
Miscellaneous Fee Items
The miscellaneous fee items resource provides a list of miscellaneous fee items present in the cart.
Show Source
Nested Schema : Scheduled Course Items
Type:
array
Title:
Scheduled Course Items
The scheduled course items resource provides a list of scheduled course items present in the cart.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : transactionReferenceContexts-carts-miscellaneousFeeItems-item-response
Type:
Show Source
object
-
CartDetailId: integer
(int64)
Title:
Miscellaneous Fee Cart ID
Read Only:true
The unique identifier of the cart detail of the miscellaneous fee item. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
The currency code associated with a miscellaneous fee. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The currency symbol associated with a miscellaneous fee. -
DiscountAmount: number
Title:
Discount Amount
Read Only:true
The numeric value of the discount amount given for a miscellaneous item. -
FeeAttributeLongDescription: string
Title:
Fee Attribute Long Description
Read Only:true
Maximum Length:240
The detailed description for the miscellaneous fee attribute. -
FeeAttributeTransactionDescription: string
Title:
Fee Attribute Transaction Description
Read Only:true
Maximum Length:100
The invoices and credit memos description. -
FeeCategoryName: string
Title:
Fee Category Name
Read Only:true
Maximum Length:50
The name of the fee category. -
FlatAmount: number
Title:
Amount
Read Only:true
The amount that will be charged for the fee. For example, a flat fee amount could be charged regardless of whether the student is an undergraduate or graduate student. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : transactionReferenceContexts-carts-scheduledCourseItems-item-response
Type:
Show Source
object
-
AcademicSubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The code for the academic subject of the scheduled course. -
CartDetailId: integer
(int64)
Title:
Scheduled Course Cart ID
Read Only:true
The unique identifier of the cart detail of the scheduled course. -
CreditTypeMeaning: string
Title:
Type of Credit Meaning
Read Only:true
Maximum Length:80
The meaning of the type of credit of the scheduled course. Valid values include Continuing education units, Credit hours, or No credit type. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
The currency code associated with a scheduled course fee. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The currency symbol associated with a scheduled course fee. -
CurriculumCatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The code for the scheduled course. -
GradingOptionName: string
Title:
Grading Option Name
Read Only:true
The name for the grading option of a scheduled course. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwningCurriculumName: string
Title:
Owning Name
Read Only:true
Maximum Length:50
The unique identifier of the parent curriculum item. -
ScheduledCourseCode: string
Title:
Scheduled Course Code
Read Only:true
Maximum Length:30
The code used to identify a scheduled course within a given course and academic period. -
SelfPacedCalculatedClassEndDate: string
(date)
Title:
Self-Paced End Date
Read Only:true
The end date of self-paced classes. -
SelfPacedClassStartDate: string
(date)
Title:
Self-Paced Start Date
The start date of self-paced classes. -
TotalAmount: number
Title:
Total Amount
Read Only:true
The numeric value of the total amount charge of a scheduled course item. -
TotalDiscountAmount: number
Title:
Total Discount Amount
Read Only:true
The numeric value of the total discount amount given for a scheduled course item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source