Jump to

• Request
• Response

Create one stocking location

post

/fscmRestApi/resources/11.13.18.05/stockingLocations

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Condition(required): string
  Maximum Length: 10

  Condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.
• ConditionMeaning(required): string
  Maximum Length: 80

  Value that indicates the condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.
• LocationType(required): string
  Maximum Length: 10

  Type of location. Valid values are TECHNICIAN, UNMANNED, MANNED, and SITE_DEDICATED. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types.
• LocationTypeMeaning(required): string
  Maximum Length: 80

  Description of the location type. Valid values are Technician, Unmanned Warehouse, Manned Warehouse, and Site Dedicated Warehouse. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization with associated attributes related to stocking locations defined in service logistics.
• OrganizationId(required): integer (int64)
  Value that uniquely identifies the inventory organization with associated attributes related to stocking locations defined in service logistics.
• OrganizationName: string
  Maximum Length: 255

  Name of the organization with associated attributes related to the stocking locations defined in service logistics.
• siteDedicatedLocations: array Site-Dedicated Locations
  Title: Site-Dedicated Locations

  Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.
• StockLocationId: integer (int64)
  Value that uniquely identifies the stocking location.
• Subinventory(required): string
  Maximum Length: 10

  Name of the subinventory with associated attributes related to stocking locations defined in service logistics.

{
    "required":[
        "Condition",
        "ConditionMeaning",
        "LocationType",
        "LocationTypeMeaning",
        "OrganizationId",
        "Subinventory"
    ],
    "type":"object",
    "properties":{
        "Condition":{
            "maxLength":"10",
            "type":"string",
            "description":"Condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the organization with associated attributes related to the stocking locations defined in service logistics.",
            "nullable":true
        },
        "StockLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the stocking location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "siteDedicatedLocations":{
            "title":"Site-Dedicated Locations",
            "type":"array",
            "description":"Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.",
            "items":{
                "$ref":"#/components/schemas/stockingLocations-siteDedicatedLocations-item-post-request"
            }
        },
        "Subinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory with associated attributes related to stocking locations defined in service logistics.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization with associated attributes related to stocking locations defined in service logistics.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization with associated attributes related to stocking locations defined in service logistics.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"35"
            }
        },
        "ConditionMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates the condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.",
            "nullable":false
        },
        "LocationType":{
            "maxLength":"10",
            "type":"string",
            "description":"Type of location. Valid values are TECHNICIAN, UNMANNED, MANNED, and SITE_DEDICATED. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LocationTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Description of the location type. Valid values are Technician, Unmanned Warehouse, Manned Warehouse, and Site Dedicated Warehouse. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types.",
            "nullable":false
        }
    }
}

Nested Schema : Site-Dedicated Locations

Type: array

Title: Site-Dedicated Locations

Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.

Show Source

• Array of: object stockingLocations-siteDedicatedLocations-item-post-request

{
    "title":"Site-Dedicated Locations",
    "type":"array",
    "description":"Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.",
    "items":{
        "$ref":"#/components/schemas/stockingLocations-siteDedicatedLocations-item-post-request"
    }
}

Nested Schema : stockingLocations-siteDedicatedLocations-item-post-request

Type: object

Show Source

• PartySiteId: integer (int64)
  Value that uniquely identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking-locations table (RCL_STOCK_LOCATION).
• PartySiteNumber: string
  Maximum Length: 30

  Number that identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking-locations table (RCL_STOCK_LOCATION).
• SiteDedicatedLocId: integer (int64)
  Value that uniquely identifies the site-dedicated location record in the dedicated sites table (RCL_SITE_DEDICATED_LOCATIONS).
• StockLocationId: integer (int64)
  Value that uniquely identifies the row in the service logistics stocking-location table (RCL_STOCK_LOCATION).

{
    "type":"object",
    "properties":{
        "PartySiteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking-locations table (RCL_STOCK_LOCATION).",
            "nullable":false
        },
        "StockLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the row in the service logistics stocking-location table (RCL_STOCK_LOCATION).",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SiteDedicatedLocId":{
            "type":"integer",
            "description":"Value that uniquely identifies the site-dedicated location record in the dedicated sites table (RCL_SITE_DEDICATED_LOCATIONS).",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking-locations table (RCL_STOCK_LOCATION).",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

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

Type: object

Show Source

• Condition: string
  Maximum Length: 10

  Condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.
• ConditionMeaning: string
  Maximum Length: 80

  Value that indicates the condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationType: string
  Maximum Length: 10

  Type of location. Valid values are TECHNICIAN, UNMANNED, MANNED, and SITE_DEDICATED. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types.
• LocationTypeMeaning: string
  Maximum Length: 80

  Description of the location type. Valid values are Technician, Unmanned Warehouse, Manned Warehouse, and Site Dedicated Warehouse. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization with associated attributes related to stocking locations defined in service logistics.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization with associated attributes related to stocking locations defined in service logistics.
• OrganizationName: string
  Maximum Length: 255

  Name of the organization with associated attributes related to the stocking locations defined in service logistics.
• siteDedicatedLocations: array Site-Dedicated Locations
  Title: Site-Dedicated Locations

  Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.
• StockLocationId: integer (int64)
  Value that uniquely identifies the stocking location.
• StockLocationName: string
  Read Only: true

  Maximum Length: 255

  Name of the stocking location that has the organization code and the subinventory.
• Subinventory: string
  Maximum Length: 10

  Name of the subinventory with associated attributes related to stocking locations defined in service logistics.

{
    "type":"object",
    "properties":{
        "StockLocationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the stocking location that has the organization code and the subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Condition":{
            "maxLength":"10",
            "type":"string",
            "description":"Condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the organization with associated attributes related to the stocking locations defined in service logistics.",
            "nullable":true,
            "x-queryable":true
        },
        "StockLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the stocking location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "siteDedicatedLocations":{
            "title":"Site-Dedicated Locations",
            "type":"array",
            "description":"Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.",
            "items":{
                "$ref":"#/components/schemas/stockingLocations-siteDedicatedLocations-item-response"
            }
        },
        "Subinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory with associated attributes related to stocking locations defined in service logistics.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization with associated attributes related to stocking locations defined in service logistics.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization with associated attributes related to stocking locations defined in service logistics.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"35"
            },
            "x-queryable":true
        },
        "ConditionMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates the condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.",
            "nullable":false,
            "x-queryable":true
        },
        "LocationType":{
            "maxLength":"10",
            "type":"string",
            "description":"Type of location. Valid values are TECHNICIAN, UNMANNED, MANNED, and SITE_DEDICATED. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LocationTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Description of the location type. Valid values are Technician, Unmanned Warehouse, Manned Warehouse, and Site Dedicated Warehouse. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types.",
            "nullable":false,
            "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 : Site-Dedicated Locations

Type: array

Title: Site-Dedicated Locations

Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.

Show Source

• Array of: object stockingLocations-siteDedicatedLocations-item-response

{
    "title":"Site-Dedicated Locations",
    "type":"array",
    "description":"Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.",
    "items":{
        "$ref":"#/components/schemas/stockingLocations-siteDedicatedLocations-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 : stockingLocations-siteDedicatedLocations-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartySiteId: integer (int64)
  Value that uniquely identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking-locations table (RCL_STOCK_LOCATION).
• PartySiteNumber: string
  Maximum Length: 30

  Number that identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking-locations table (RCL_STOCK_LOCATION).
• SiteDedicatedLocId: integer (int64)
  Value that uniquely identifies the site-dedicated location record in the dedicated sites table (RCL_SITE_DEDICATED_LOCATIONS).
• StockLocationId: integer (int64)
  Value that uniquely identifies the row in the service logistics stocking-location table (RCL_STOCK_LOCATION).

{
    "type":"object",
    "properties":{
        "PartySiteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking-locations table (RCL_STOCK_LOCATION).",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StockLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the row in the service logistics stocking-location table (RCL_STOCK_LOCATION).",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SiteDedicatedLocId":{
            "type":"integer",
            "description":"Value that uniquely identifies the site-dedicated location record in the dedicated sites table (RCL_SITE_DEDICATED_LOCATIONS).",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking-locations table (RCL_STOCK_LOCATION).",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "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

siteDedicatedLocations

Operation: /fscmRestApi/resources/11.13.18.05/stockingLocations/{StockLocationId}/child/siteDedicatedLocations

Parameters:

• StockLocationId: $request.path.StockLocationId

Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.

Back to Top