Jump to

• Request
• Response

Create lot-specific conversions

post

/fscmRestApi/resources/11.13.18.05/generateLotUnitOfMeasureConversions

Request

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ConversionFactor: number
  Calculated rate of conversion to convert a FromUOM value to the ToUOM value. For example, you can have a FromUOM of Dozen and a ToUOM of Each. The calculated rate for the conversion factor would be 12.
• FromQuantity: number
  Default Value: 1

  Value of a quantity to be converted from the FromUOM unit to the ToUOM unit. The default value is 1. If the value of FromQuantity is greater than 1, then the ToQuantity attribute will be populated with the calculated quantity.
• FromUOM: string
  Name of the unit of measure the conversion is from. This attribute is required.
• InputDateTime: string
  Date and time used to construct the conversion factor. If not provided, the current date and time are used.
• ItemId: string
  Value that uniquely identifies the inventory item for this conversion calculation. This attribute is required.
• LotNumber: string
  Value that uniquely identifies the inventory lot for this conversion calculation. This attribute is required.
• OrganizationId: string
  Value that uniquely identifies the inventory organization for this conversion calculation. This attribute is required.
• PrecisionFlag: boolean
  Default Value: true

  Contains one of the following values: true or false. If true, then the conversion calculations will be rounded to the precision stored as the value of profile option INV_QUANTITY_DECIMAL_PRECISION, that has a default value of 5. If false, then no precision is used to round the calculated value. The default value is false.
• ReturnMessage: string
  Message that includes details about errors that occurred during the calculation of the conversion factor. The errors mostly occur due to missing conversions for the specified item.
• ReturnMessageCode: string
  Value of the error message if the ReturnStatus is false and the conversion failed to calculate.
• ReturnStatus: string
  Status of whether the conversion factor was successfully created based on the input values for FromUOM and ToUOM and the optional item identifier. Contains one of the following values: true or false. If true, then the conversion factor was successfully calculated. If false, then the conversion failed to calculate.
• ToQuantity: number
  Value of the FromQuantity multiplied by the conversion factor using precision, if requested.
• ToUOM: string
  Name of the unit of measure the conversion is being made to. This attribute is required.

{
    "type":"object",
    "properties":{
        "ConversionFactor":{
            "type":"number",
            "description":"Calculated rate of conversion to convert a FromUOM value to the ToUOM value. For example, you can have a FromUOM of Dozen and a ToUOM of Each. The calculated rate for the conversion factor would be 12.",
            "nullable":true,
            "x-queryable":false
        },
        "FromQuantity":{
            "type":"number",
            "description":"Value of a quantity to be converted from the FromUOM unit to the ToUOM unit. The default value is 1. If the value of FromQuantity is greater than 1, then the ToQuantity attribute will be populated with the calculated quantity.",
            "nullable":true,
            "default":1,
            "x-queryable":false
        },
        "FromUOM":{
            "type":"string",
            "description":"Name of the unit of measure the conversion is from. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "InputDateTime":{
            "type":"string",
            "description":"Date and time used to construct the conversion factor. If not provided, the current date and time are used.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemId":{
            "type":"string",
            "description":"Value that uniquely identifies the inventory item for this conversion calculation. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "LotNumber":{
            "type":"string",
            "description":"Value that uniquely identifies the inventory lot for this conversion calculation. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "type":"string",
            "description":"Value that uniquely identifies the inventory organization for this conversion calculation. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "PrecisionFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the conversion calculations will be rounded to the precision stored as the value of profile option INV_QUANTITY_DECIMAL_PRECISION, that has a default value of 5. If false, then no precision is used to round the calculated value. The default value is false.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "ReturnMessage":{
            "type":"string",
            "description":"Message that includes details about errors that occurred during the calculation of the conversion factor. The errors mostly occur due to missing conversions for the specified item.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageCode":{
            "type":"string",
            "description":"Value of the error message if the ReturnStatus is false and the conversion failed to calculate.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Status of whether the conversion factor was successfully created based on the input values for FromUOM and ToUOM and the optional item identifier. Contains one of the following values: true or false. If true, then the conversion factor was successfully calculated. If false, then the conversion failed to calculate.",
            "nullable":true,
            "x-queryable":false
        },
        "ToQuantity":{
            "type":"number",
            "description":"Value of the FromQuantity multiplied by the conversion factor using precision, if requested.",
            "nullable":true,
            "x-queryable":false
        },
        "ToUOM":{
            "type":"string",
            "description":"Name of the unit of measure the conversion is being made to. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : generateLotUnitOfMeasureConversions-item-response

Type: object

Show Source

• ConversionFactor: number
  Calculated rate of conversion to convert a FromUOM value to the ToUOM value. For example, you can have a FromUOM of Dozen and a ToUOM of Each. The calculated rate for the conversion factor would be 12.
• FromQuantity: number
  Default Value: 1

  Value of a quantity to be converted from the FromUOM unit to the ToUOM unit. The default value is 1. If the value of FromQuantity is greater than 1, then the ToQuantity attribute will be populated with the calculated quantity.
• FromUOM: string
  Name of the unit of measure the conversion is from. This attribute is required.
• InputDateTime: string
  Date and time used to construct the conversion factor. If not provided, the current date and time are used.
• ItemId: string
  Value that uniquely identifies the inventory item for this conversion calculation. This attribute is required.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotNumber: string
  Value that uniquely identifies the inventory lot for this conversion calculation. This attribute is required.
• OrganizationId: string
  Value that uniquely identifies the inventory organization for this conversion calculation. This attribute is required.
• PrecisionFlag: boolean
  Default Value: true

  Contains one of the following values: true or false. If true, then the conversion calculations will be rounded to the precision stored as the value of profile option INV_QUANTITY_DECIMAL_PRECISION, that has a default value of 5. If false, then no precision is used to round the calculated value. The default value is false.
• ReturnMessage: string
  Message that includes details about errors that occurred during the calculation of the conversion factor. The errors mostly occur due to missing conversions for the specified item.
• ReturnMessageCode: string
  Value of the error message if the ReturnStatus is false and the conversion failed to calculate.
• ReturnStatus: string
  Status of whether the conversion factor was successfully created based on the input values for FromUOM and ToUOM and the optional item identifier. Contains one of the following values: true or false. If true, then the conversion factor was successfully calculated. If false, then the conversion failed to calculate.
• ToQuantity: number
  Value of the FromQuantity multiplied by the conversion factor using precision, if requested.
• ToUOM: string
  Name of the unit of measure the conversion is being made to. This attribute is required.

{
    "type":"object",
    "properties":{
        "ConversionFactor":{
            "type":"number",
            "description":"Calculated rate of conversion to convert a FromUOM value to the ToUOM value. For example, you can have a FromUOM of Dozen and a ToUOM of Each. The calculated rate for the conversion factor would be 12.",
            "nullable":true,
            "x-queryable":false
        },
        "FromQuantity":{
            "type":"number",
            "description":"Value of a quantity to be converted from the FromUOM unit to the ToUOM unit. The default value is 1. If the value of FromQuantity is greater than 1, then the ToQuantity attribute will be populated with the calculated quantity.",
            "nullable":true,
            "default":1,
            "x-queryable":false
        },
        "FromUOM":{
            "type":"string",
            "description":"Name of the unit of measure the conversion is from. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "InputDateTime":{
            "type":"string",
            "description":"Date and time used to construct the conversion factor. If not provided, the current date and time are used.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemId":{
            "type":"string",
            "description":"Value that uniquely identifies the inventory item for this conversion calculation. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "LotNumber":{
            "type":"string",
            "description":"Value that uniquely identifies the inventory lot for this conversion calculation. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "type":"string",
            "description":"Value that uniquely identifies the inventory organization for this conversion calculation. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "PrecisionFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the conversion calculations will be rounded to the precision stored as the value of profile option INV_QUANTITY_DECIMAL_PRECISION, that has a default value of 5. If false, then no precision is used to round the calculated value. The default value is false.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "ReturnMessage":{
            "type":"string",
            "description":"Message that includes details about errors that occurred during the calculation of the conversion factor. The errors mostly occur due to missing conversions for the specified item.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageCode":{
            "type":"string",
            "description":"Value of the error message if the ReturnStatus is false and the conversion failed to calculate.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Status of whether the conversion factor was successfully created based on the input values for FromUOM and ToUOM and the optional item identifier. Contains one of the following values: true or false. If true, then the conversion factor was successfully calculated. If false, then the conversion failed to calculate.",
            "nullable":true,
            "x-queryable":false
        },
        "ToQuantity":{
            "type":"number",
            "description":"Value of the FromQuantity multiplied by the conversion factor using precision, if requested.",
            "nullable":true,
            "x-queryable":false
        },
        "ToUOM":{
            "type":"string",
            "description":"Name of the unit of measure the conversion is being made to. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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