Jump to

• Request
• Response

Get all shopping list lines on a specific shopping list

get

/fscmRestApi/resources/11.13.18.05/personalShoppingLists/{PersonalShoppingListHeaderId}/child/lines

Request

Path Parameters

• PersonalShoppingListHeaderId(required): integer(int64)
  Value that uniquely identifies the personal shopping list.

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>
• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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:
    Finder Variables:
    • PersonalShoppingListLineId; integer; Value that uniquely identifies the personal shopping list line.
• 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:
  

  • Amount; number; Total amount of the shopping list line item in the currency of the buying company.
  • BPAPriceUserOverrideFlag; boolean; Contains one of the following values: true or false. If true, then the blanket purchase agreement price attribute referenced by the personal shopping list line has been updated by user. If false, then the blanket purchase agreement price attribute hasn't been updated by user. The default value is false. This attribute isn't currently used.
  • CategoryId; integer; Value that uniquely identifies the purchasing category of the shopping list line.
  • CategoryName; string; Name that uniquely identifies the purchasing category of the personal shopping list line.
  • ConversionRate; number; Type of rate used to determine the currency conversion rate for the purchase requisition.
  • ConversionRateDate; string; Date from when the conversion rate is used to convert an amount into another currency.
  • ConversionRateType; string; Type of rate used to determine the currency conversion rate for the purchase requisition.
  • CurrencyCode; string; Abbreviation that identifies the shopping list line currency.
  • Item; string; Abbreviation that uniquely identifies the item on the shopping list line.
  • ItemDescription; string; Description of the goods or services on the shopping list line.
  • ItemRevision; string; Number that identifies the revision of the item.
  • ItemSource; string;
  • LineType; string; Name that uniquely identifies type that indicates whether the shopping list line is for goods or services.
  • LineTypeId; integer; Value that uniquely identifies type that indicates whether the shopping list line is for goods or services.
  • ManufacturerId; number; Value that uniquely identifies the manufacturer of the item on the shopping list line.
  • ManufacturerName; string; Name that uniquely identifies the manufacturer of the item on the personal shopping list line.
  • ManufacturerPartNumber; string; Number that uniquely identifies the item as provided by the manufacturer.
  • NegotiatedByPreparerFlag; boolean; Contains one of the following values: true or false. If true, then the price of the item on the shopping list line is agreed on in advance between the buying company and the supplier. If false, then the price isn't agreed on in advance. This attribute doesn't have a default value.
  • NegotiationRequiredFlag; boolean; Contains one of the following values: true or false. If true, then an request for quotation is required prior to placing the requisition line on a purchase order. If false, then an request for quotation isn't required. This attribute doesn't have a default value.
  • NewSupplierFlag; boolean; Contains one of the following values: true or false. If true, then the supplier on the shopping list line is a new supplier. If false, then the supplier on the shopping list line is an existing supplier. This attribute doesn't have a default value.
  • PersonalShoppingListHeaderId; integer; Value that uniquely identifies the personal shopping list.
  • PersonalShoppingListLineId; integer; Value that uniquely identifies the personal shopping list line.
  • PublicShoppingListHeaderId; integer; Value that uniquely identifies the public shopping list.
  • PunchoutCatalog; string; Name of the punchout catalog referenced by the shopping list line.
  • PunchoutCatalogId; integer; Value that uniquely identifies the punchout catalog referenced by the shopping list line.
  • RequisitioningBU; string; Name of the requisitioning business unit referenced by the shopping list line.
  • RequisitioningBUId; integer; Value that uniquely identifies the requisitioning business unit referenced by the shopping list line.
  • SmartFormId; integer; Value that uniquely identifies the smart form referenced by the shopping list line.
  • SourceAgreement; string; Number that uniquely identifies the source agreement referenced by the shopping list line.
  • SourceAgreementHeaderId; integer; Value that uniquely identifies the source agreement referenced by the shopping list line.
  • SourceAgreementLineId; integer; Value that uniquely identifies the source agreement line for a given source agreement.
  • SuggestedQuantity; number; Default quantity for the personal shopping list line.
  • SuggestedSupplier; string; Name of the new supplier suggested on the shopping list line for fulfillment of the ordered goods and services.
  • SuggestedSupplierContact; string; Name of the person representing the new supplier involved in supporting the customer relationship.
  • SuggestedSupplierContactEmail; string; Email address of the person representing the new supplier.
  • SuggestedSupplierContactFax; string; Fax number of the person representing the new supplier.
  • SuggestedSupplierContactPhone; string; Phone number of the person representing the new supplier.
  • SuggestedSupplierItemNumber; string; Number that uniquely identifies the item as provided by the suggested supplier.
  • SuggestedSupplierSite; string; Value that uniquely identifies the new supplier.
  • SupplierContactId; integer; Value that uniquely identifies the supplier contact.
  • SupplierId; integer; Value that uniquely identifies the supplier.
  • SupplierSiteId; integer; Value that uniquely identifies the supplier site.
  • UOMCode; string; Abbreviation that identifies the unit of measure.
  • UnitPrice; number; Price of the shopping list line item in the currency of the buying company.
• 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

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : personalShoppingLists-lines

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/personalShoppingLists-lines-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object personalShoppingLists-lines-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/personalShoppingLists-lines-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : personalShoppingLists-lines-item-response

Type: object

Show Source

• Amount: number
  Total amount of the shopping list line item in the currency of the buying company.
• BPAPriceUserOverrideFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the blanket purchase agreement price attribute referenced by the personal shopping list line has been updated by user. If false, then the blanket purchase agreement price attribute hasn't been updated by user. The default value is false. This attribute isn't currently used.
• CategoryId: integer (int64)
  Value that uniquely identifies the purchasing category of the shopping list line.
• CategoryName: string
  Maximum Length: 2400

  Name that uniquely identifies the purchasing category of the personal shopping list line.
• ConversionRate: number
  Type of rate used to determine the currency conversion rate for the purchase requisition.
• ConversionRateDate: string (date)
  Date from when the conversion rate is used to convert an amount into another currency.
• ConversionRateType: string
  Maximum Length: 30

  Type of rate used to determine the currency conversion rate for the purchase requisition.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the shopping list line.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the shopping list line was created.
• Currency: string
  Title: Currency Name

  Maximum Length: 80

  Name of the shopping list line currency.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the shopping list line currency.
• InventoryOrganization: string
  Title: Organization

  Maximum Length: 240

  Name of the inventory organization that's the source for the master item used on the personal shopping list line.
• InventoryOrganizationCode: string
  Maximum Length: 18

  Abbreviation that uniquely identifies the inventory organization that's the source for the master item on the personal shopping list line.
• InventoryOrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's the source for the master item on the personal shopping list line.
• Item: string
  Maximum Length: 300

  Abbreviation that uniquely identifies the item on the shopping list line.
• ItemDescription: string
  Maximum Length: 240

  Description of the goods or services on the shopping list line.
• ItemId: integer (int64)
  Value that uniquely identifies the item on the shopping list line.
• ItemRevision: string
  Maximum Length: 18

  Number that identifies the revision of the item.
• ItemSource: string
  Maximum Length: 25
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the shopping list line was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the shopping list line.
• LineImageURL: string
  Title: Image URL

  Read Only: true

  Image URL of the goods or services on the personal shopping list line.
• LineType: string
  Title: Type

  Maximum Length: 30

  Name that uniquely identifies type that indicates whether the shopping list line is for goods or services.
• LineTypeId: integer (int64)
  Value that uniquely identifies type that indicates whether the shopping list line is for goods or services.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManufacturerId: number
  Value that uniquely identifies the manufacturer of the item on the shopping list line.
• ManufacturerName: string
  Maximum Length: 240

  Name that uniquely identifies the manufacturer of the item on the personal shopping list line.
• ManufacturerPartNumber: string
  Maximum Length: 700

  Number that uniquely identifies the item as provided by the manufacturer.
• NegotiatedByPreparerFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the price of the item on the shopping list line is agreed on in advance between the buying company and the supplier. If false, then the price isn't agreed on in advance. This attribute doesn't have a default value.
• NegotiationRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then an request for quotation is required prior to placing the requisition line on a purchase order. If false, then an request for quotation isn't required. This attribute doesn't have a default value.
• NewSupplierFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the supplier on the shopping list line is a new supplier. If false, then the supplier on the shopping list line is an existing supplier. This attribute doesn't have a default value.
• PersonalShoppingListHeaderId: integer (int64)
  Value that uniquely identifies the personal shopping list.
• PersonalShoppingListLineId: integer (int64)
  Value that uniquely identifies the personal shopping list line.
• PublicShoppingListHeaderId: integer (int64)
  Value that uniquely identifies the public shopping list.
• PunchoutCatalog: string
  Read Only: true

  Maximum Length: 30

  Name of the punchout catalog referenced by the shopping list line.
• PunchoutCatalogId: integer (int64)
  Value that uniquely identifies the punchout catalog referenced by the shopping list line.
• RequisitioningBU: string
  Title: Business Unit

  Maximum Length: 240

  Name of the requisitioning business unit referenced by the shopping list line.
• RequisitioningBUId: integer (int64)
  Value that uniquely identifies the requisitioning business unit referenced by the shopping list line.
• SmartFormId: integer (int64)
  Value that uniquely identifies the smart form referenced by the shopping list line.
• SmartFormName: string
  Maximum Length: 250

  Name that uniquely identifies the smart form referenced by the personal shopping list line.
• SourceAgreement: string
  Title: Agreement

  Maximum Length: 30

  Number that uniquely identifies the source agreement referenced by the shopping list line.
• SourceAgreementHeaderId: integer (int64)
  Value that uniquely identifies the source agreement referenced by the shopping list line.
• SourceAgreementLineId: integer (int64)
  Value that uniquely identifies the source agreement line for a given source agreement.
• SourceAgreementLineNumber: number
  Title: Agreement Line

  Number that identifies the line of the source agreement referenced by the shopping list line.
• SuggestedQuantity: number
  Default quantity for the personal shopping list line.
• SuggestedSupplier: string
  Maximum Length: 360

  Name of the new supplier suggested on the shopping list line for fulfillment of the ordered goods and services.
• SuggestedSupplierContact: string
  Maximum Length: 80

  Name of the person representing the new supplier involved in supporting the customer relationship.
• SuggestedSupplierContactEmail: string
  Maximum Length: 1000

  Email address of the person representing the new supplier.
• SuggestedSupplierContactFax: string
  Maximum Length: 30

  Fax number of the person representing the new supplier.
• SuggestedSupplierContactPhone: string
  Maximum Length: 30

  Phone number of the person representing the new supplier.
• SuggestedSupplierItemNumber: string
  Maximum Length: 300

  Number that uniquely identifies the item as provided by the suggested supplier.
• SuggestedSupplierSite: string
  Maximum Length: 240

  Value that uniquely identifies the new supplier.
• Supplier: string
  Maximum Length: 360

  Name of the supplier tasked with fulfillment of the shopping list line goods or services.
• SupplierContact: string
  Maximum Length: 4000

  Name of the person representing the supplier with regards to communication with the buying company.
• SupplierContactEmail: string
  Read Only: true

  Maximum Length: 2000

  Email address of the person representing the supplier.
• SupplierContactFax: string
  Read Only: true

  Maximum Length: 255

  Fax number of the person representing the supplier.
• SupplierContactId: integer (int64)
  Value that uniquely identifies the supplier contact.
• SupplierContactPhone: string
  Read Only: true

  Maximum Length: 255

  Phone number of the person representing the supplier.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier.
• SupplierSite: string
  Title: Supplier Site

  Maximum Length: 240

  Name of the supplier location from where the shopping list line goods or services are purchased.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site.
• UnitPrice: number
  Price of the shopping list line item in the currency of the buying company.
• UOM: string
  Title: UOM Name

  Maximum Length: 25

  Unit of measure of the item quantity.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the shopping list line was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning business unit referenced by the shopping list line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LineTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies type that indicates whether the shopping list line is for goods or services.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SuggestedSupplierContactFax":{
            "maxLength":"30",
            "type":"string",
            "description":"Fax number of the person representing the new supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "ManufacturerId":{
            "type":"number",
            "description":"Value that uniquely identifies the manufacturer of the item on the shopping list line.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierContactEmail":{
            "maxLength":"2000",
            "type":"string",
            "description":"Email address of the person representing the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SuggestedSupplierContactPhone":{
            "maxLength":"30",
            "type":"string",
            "description":"Phone number of the person representing the new supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item on the shopping list line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SuggestedSupplierSite":{
            "maxLength":"240",
            "type":"string",
            "description":"Value that uniquely identifies the new supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the shopping list line currency.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":"300",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the item on the shopping list line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryOrganizationId",
                    "InventoryOrganizationCode",
                    "InventoryOrganization"
                ]
            },
            "x-queryable":true
        },
        "RequisitioningBU":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the requisitioning business unit referenced by the shopping list line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InventoryOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's the source for the master item on the personal shopping list line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Currency":{
            "title":"Currency Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the shopping list line currency.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRevision":{
            "maxLength":"18",
            "type":"string",
            "description":"Number that identifies the revision of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SuggestedSupplierItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that uniquely identifies the item as provided by the suggested supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the shopping list line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the shopping list line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SuggestedSupplier":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the new supplier suggested on the shopping list line for fulfillment of the ordered goods and services.",
            "nullable":true,
            "x-queryable":true
        },
        "ManufacturerName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name that uniquely identifies the manufacturer of the item on the personal shopping list line.",
            "nullable":true,
            "x-queryable":true
        },
        "BPAPriceUserOverrideFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the blanket purchase agreement price attribute referenced by the personal shopping list line has been updated by user. If false, then the blanket purchase agreement price attribute hasn't been updated by user. The default value is false. This attribute isn't currently used.",
            "nullable":true,
            "x-queryable":true
        },
        "SmartFormName":{
            "maxLength":"250",
            "type":"string",
            "description":"Name that uniquely identifies the smart form referenced by the personal shopping list line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "ManufacturerPartNumber":{
            "maxLength":"700",
            "type":"string",
            "description":"Number that uniquely identifies the item as provided by the manufacturer.",
            "nullable":true,
            "x-queryable":true
        },
        "PunchoutCatalog":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the punchout catalog referenced by the shopping list line.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NegotiationRequiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then an request for quotation is required prior to placing the requisition line on a purchase order. If false, then an request for quotation isn't required. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceAgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source agreement referenced by the shopping list line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryOrganization":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the inventory organization that's the source for the master item used on the personal shopping list line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PersonalShoppingListHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the personal shopping list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the supplier location from where the shopping list line goods or services are purchased.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SupplierId",
                    "Supplier"
                ]
            }
        },
        "SmartFormId":{
            "type":"integer",
            "description":"Value that uniquely identifies the smart form referenced by the shopping list line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierContactPhone":{
            "maxLength":"255",
            "type":"string",
            "description":"Phone number of the person representing the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AreaCode",
                    "Phone",
                    "PhoneCountryCode",
                    "PhoneExtension"
                ]
            }
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category of the shopping list line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceAgreementLineNumber":{
            "title":"Agreement Line",
            "type":"number",
            "description":"Number that identifies the line of the source agreement referenced by the shopping list line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierContact":{
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the person representing the supplier with regards to communication with the buying company.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SupplierSiteId",
                    "SupplierSite"
                ]
            }
        },
        "SupplierContactFax":{
            "maxLength":"255",
            "type":"string",
            "description":"Fax number of the person representing the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Fax",
                    "FaxAreaCode",
                    "FaxCountryCode"
                ]
            }
        },
        "ItemDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the goods or services on the shopping list line.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of rate used to determine the currency conversion rate for the purchase requisition.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NewSupplierFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the supplier on the shopping list line is a new supplier. If false, then the supplier on the shopping list line is an existing supplier. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier tasked with fulfillment of the shopping list line goods or services.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConversionRateDate":{
            "type":"string",
            "description":"Date from when the conversion rate is used to convert an amount into another currency.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LineType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Name that uniquely identifies type that indicates whether the shopping list line is for goods or services.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceAgreement":{
            "title":"Agreement",
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the source agreement referenced by the shopping list line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SupplierSite",
                    "SupplierSiteId"
                ]
            },
            "x-queryable":true
        },
        "PunchoutCatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the punchout catalog referenced by the shopping list line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryOrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the inventory organization that's the source for the master item on the personal shopping list line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Amount":{
            "type":"number",
            "description":"Total amount of the shopping list line item in the currency of the buying company.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemSource":{
            "maxLength":"25",
            "type":"string",
            "description":"",
            "nullable":false,
            "x-queryable":true
        },
        "SourceAgreementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source agreement line for a given source agreement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NegotiatedByPreparerFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the price of the item on the shopping list line is agreed on in advance between the buying company and the supplier. If false, then the price isn't agreed on in advance. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "SuggestedSupplierContact":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the person representing the new supplier involved in supporting the customer relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "UOM":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure of the item quantity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit",
                "dependencies":[
                    "ItemId",
                    "Item",
                    "RequisitioningBUId",
                    "RequisitioningBU"
                ]
            }
        },
        "UnitPrice":{
            "type":"number",
            "description":"Price of the shopping list line item in the currency of the buying company.",
            "nullable":true,
            "x-queryable":true
        },
        "PublicShoppingListHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the public shopping list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConversionRate":{
            "type":"number",
            "description":"Type of rate used to determine the currency conversion rate for the purchase requisition.",
            "nullable":true,
            "x-queryable":true
        },
        "SuggestedSupplierContactEmail":{
            "maxLength":"1000",
            "type":"string",
            "description":"Email address of the person representing the new supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SuggestedQuantity":{
            "type":"number",
            "description":"Default quantity for the personal shopping list line.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":"2400",
            "type":"string",
            "description":"Name that uniquely identifies the purchasing category of the personal shopping list line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LineImageURL":{
            "title":"Image URL",
            "type":"string",
            "description":"Image URL of the goods or services on the personal shopping list line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AgreementImageURL",
                    "MasterItemImageURL",
                    "SmartFormImageURL"
                ]
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the shopping list line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonalShoppingListLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the personal shopping list line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top