Jump to

• Request
• Response

Update one ship-to assignment

patch

/fscmRestApi/resources/11.13.18.05/b2bAccountNumbers/{AccountNumberId}/child/shipToAssignments/{ShipToAssignmentId}

Request

Path Parameters

• AccountNumberId(required): integer(int64)
  Unique identifier of the B2B account number. This value is derived.
• ShipToAssignmentId(required): integer(int64)
  Unique identifier for the Ship to Location Assignment. Its value is an application-generated unique ID.

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

• AccountNumberId: integer (int64)
  Unique identifier of the B2B account number. This is a foreign key to the cmk account numbers table.
• Address: string
  Maximum Length: 255

  Address of the ship-to location.
• Set: string
  Maximum Length: 255

  Code of the set to which the location belongs, for example, common set.
• ShipToAssignmentId: integer (int64)
  Unique identifier for the Ship to Location Assignment. Its value is an application-generated unique ID.
• ShipToLocationCode: string
  Maximum Length: 255

  Ship-to location code. This is a required field.
• ShipToLocationId: integer (int64)
  Unique identifier of the ship-to location. This value is derived.

{
    "type":"object",
    "properties":{
        "ShipToLocationId":{
            "type":"integer",
            "description":"Unique identifier of the ship-to location. This value is derived.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Set":{
            "maxLength":255,
            "type":"string",
            "description":"Code of the set to which the location belongs, for example, common set.",
            "nullable":true
        },
        "Address":{
            "maxLength":255,
            "type":"string",
            "description":"Address of the ship-to location.",
            "nullable":true
        },
        "ShipToAssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the Ship to Location Assignment. Its value is an application-generated unique ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ShipToLocationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Ship-to location code. This is a required field.",
            "nullable":true
        },
        "AccountNumberId":{
            "type":"integer",
            "description":"Unique identifier of the B2B account number. This is a foreign key to the cmk account numbers table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "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(required):
  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(required):
  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 : b2bAccountNumbers-shipToAssignments-item-response

Type: object

Show Source

• AccountNumberId: integer (int64)
  Unique identifier of the B2B account number. This is a foreign key to the cmk account numbers table.
• Address: string
  Maximum Length: 255

  Address of the ship-to location.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Set: string
  Maximum Length: 255

  Code of the set to which the location belongs, for example, common set.
• ShipToAssignmentId: integer (int64)
  Unique identifier for the Ship to Location Assignment. Its value is an application-generated unique ID.
• ShipToLocationCode: string
  Maximum Length: 255

  Ship-to location code. This is a required field.
• ShipToLocationId: integer (int64)
  Unique identifier of the ship-to location. This value is derived.

{
    "type":"object",
    "properties":{
        "ShipToLocationId":{
            "type":"integer",
            "description":"Unique identifier of the ship-to location. This value is derived.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Set":{
            "maxLength":255,
            "type":"string",
            "description":"Code of the set to which the location belongs, for example, common set.",
            "nullable":true,
            "x-queryable":true
        },
        "Address":{
            "maxLength":255,
            "type":"string",
            "description":"Address of the ship-to location.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToAssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the Ship to Location Assignment. Its value is an application-generated unique ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToLocationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Ship-to location code. This is a required field.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountNumberId":{
            "type":"integer",
            "description":"Unique identifier of the B2B account number. This is a foreign key to the cmk account numbers table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "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"
    }
}

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