Jump to

• Request
• Response

Create lots

post

/fscmRestApi/resources/11.13.18.05/pickTransactions/{TransactionHeaderId}/child/pickLines/{pickLinesUniqID}/child/lotSerialItemLots

Request

Path Parameters

• TransactionHeaderId(required): integer
  Value that uniquely identifies the inventory transaction header.
• pickLinesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Pick Lines resource and used to uniquely identify an instance of Pick Lines. The client should not generate the hash key value. Instead, the client should query on the Pick Lines collection resource in order to navigate to a specific instance of Pick Lines to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Lot(required): string
  Maximum Length: 80

  Value that uniquely identifies the lot that includes the picked item. The lot includes items that you produce together as a group and that share similar production costs and specifications. Applies when the warehouse places the item under lot and serial control.
• lotSerialItemSerials: array Serials That Share Control
  Title: Serials That Share Control

  The Serials That Share Control resource manages the serial that controls the picked item. Use it when lots and serials control the item.
• Quantity(required): number
  Quantity picked for the lot. Applies when the warehouse places the item under lot and serial control.
• SecondaryQuantity: number
  Quantity picked for the lot using the secondary unit of measure. Applies when the warehouse places the item under lot and serial control.

{
    "required":[
        "Lot",
        "Quantity"
    ],
    "type":"object",
    "properties":{
        "Lot":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that uniquely identifies the lot that includes the picked item. The lot includes items that you produce together as a group and that share similar production costs and specifications. Applies when the warehouse places the item under lot and serial control.",
            "nullable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity picked for the lot. Applies when the warehouse places the item under lot and serial control.",
            "nullable":false
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Quantity picked for the lot using the secondary unit of measure. Applies when the warehouse places the item under lot and serial control.",
            "nullable":true
        },
        "lotSerialItemSerials":{
            "title":"Serials That Share Control",
            "type":"array",
            "description":"The Serials That Share Control resource manages the serial that controls the picked item. Use it when lots and serials control the item.",
            "items":{
                "$ref":"#/components/schemas/pickTransactions-pickLines-lotSerialItemLots-lotSerialItemSerials-item-post-request"
            }
        }
    }
}

Nested Schema : Serials That Share Control

Type: array

Title: Serials That Share Control

The Serials That Share Control resource manages the serial that controls the picked item. Use it when lots and serials control the item.

Show Source

• Array of: object schema

{
    "title":"Serials That Share Control",
    "type":"array",
    "description":"The Serials That Share Control resource manages the serial that controls the picked item. Use it when lots and serials control the item.",
    "items":{
        "$ref":"#/components/schemas/pickTransactions-pickLines-lotSerialItemLots-lotSerialItemSerials-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• FromSerialNumber: string
  Maximum Length: 80

  Number that identifies the starting serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control.
• ToSerialNumber: string
  Maximum Length: 80

  Number that identifies the ending serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control.

{
    "type":"object",
    "properties":{
        "FromSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the starting serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control.",
            "nullable":false
        },
        "ToSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the ending serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control.",
            "nullable":true
        }
    }
}

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 : pickTransactions-pickLines-lotSerialItemLots-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Lot: string
  Maximum Length: 80

  Value that uniquely identifies the lot that includes the picked item. The lot includes items that you produce together as a group and that share similar production costs and specifications. Applies when the warehouse places the item under lot and serial control.
• lotSerialItemSerials: array Serials That Share Control
  Title: Serials That Share Control

  The Serials That Share Control resource manages the serial that controls the picked item. Use it when lots and serials control the item.
• Quantity: number
  Quantity picked for the lot. Applies when the warehouse places the item under lot and serial control.
• SecondaryQuantity: number
  Quantity picked for the lot using the secondary unit of measure. Applies when the warehouse places the item under lot and serial control.

{
    "type":"object",
    "properties":{
        "Lot":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that uniquely identifies the lot that includes the picked item. The lot includes items that you produce together as a group and that share similar production costs and specifications. Applies when the warehouse places the item under lot and serial control.",
            "nullable":false,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity picked for the lot. Applies when the warehouse places the item under lot and serial control.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Quantity picked for the lot using the secondary unit of measure. Applies when the warehouse places the item under lot and serial control.",
            "nullable":true,
            "x-queryable":true
        },
        "lotSerialItemSerials":{
            "title":"Serials That Share Control",
            "type":"array",
            "description":"The Serials That Share Control resource manages the serial that controls the picked item. Use it when lots and serials control the item.",
            "items":{
                "$ref":"#/components/schemas/pickTransactions-pickLines-lotSerialItemLots-lotSerialItemSerials-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 : Serials That Share Control

Type: array

Title: Serials That Share Control

The Serials That Share Control resource manages the serial that controls the picked item. Use it when lots and serials control the item.

Show Source

• Array of: object pickTransactions-pickLines-lotSerialItemLots-lotSerialItemSerials-item-response

{
    "title":"Serials That Share Control",
    "type":"array",
    "description":"The Serials That Share Control resource manages the serial that controls the picked item. Use it when lots and serials control the item.",
    "items":{
        "$ref":"#/components/schemas/pickTransactions-pickLines-lotSerialItemLots-lotSerialItemSerials-item-response"
    }
}

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."
        }
    }
}

Nested Schema : pickTransactions-pickLines-lotSerialItemLots-lotSerialItemSerials-item-response

Type: object

Show Source

• FromSerialNumber: string
  Maximum Length: 80

  Number that identifies the starting serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ToSerialNumber: string
  Maximum Length: 80

  Number that identifies the ending serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the starting serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control.",
            "nullable":false,
            "x-queryable":true
        },
        "ToSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the ending serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control.",
            "nullable":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"
    }
}

Links

lotSerialItemSerials

Operation: /fscmRestApi/resources/11.13.18.05/pickTransactions/{TransactionHeaderId}/child/pickLines/{pickLinesUniqID}/child/lotSerialItemLots/{lotSerialItemLotsUniqID}/child/lotSerialItemSerials

Parameters:

• TransactionHeaderId: $request.path.TransactionHeaderId
• lotSerialItemLotsUniqID: $request.path.lotSerialItemLotsUniqID
• pickLinesUniqID: $request.path.pickLinesUniqID

The Serials That Share Control resource manages the serial that controls the picked item. Use it when lots and serials control the item.

Back to Top