Jump to

• Request
• Response

Update one serial

patch

/fscmRestApi/resources/11.13.18.05/shippingPackingUnits/{PackingUnitHistoryId}/child/nestedPackingUnits/{PackingUnitHistoryId2}/child/contents/{PackingUnitContentId2}/child/serials/{serialsUniqID}

Request

Path Parameters

• PackingUnitContentId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• PackingUnitHistoryId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• PackingUnitHistoryId2(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• serialsUniqID(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

{
    "type":"object",
    "properties":{
    }
}

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 : shippingPackingUnits-nestedPackingUnits-contents-serials-item-response

Type: object

Show Source

• CurrentOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization.
• CurrentStatus: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the current status of the serial number of the content item.
• CurrentStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  Description of the current status of the serial number of the content item.
• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that identifies the content item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotNumber: string
  Read Only: true

  Maximum Length: 80

  Value that identifies the lot or batch of the content item.
• PackingUnitId: integer (int64)
  Read Only: true

  Value that uniquely identifies the license plate number.
• Revision: string
  Read Only: true

  Maximum Length: 18

  Revision of the item.
• SerialNumber: string
  Read Only: true

  Maximum Length: 80

  Serial number of the container item, if container item is under serial control.

{
    "type":"object",
    "properties":{
        "CurrentOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the current status of the serial number of the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Description of the current status of the serial number of the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the lot or batch of the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PackingUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the license plate number.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Revision":{
            "maxLength":18,
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Serial number of the container item, if container item is under serial control.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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