Skip to main content
PUT
Bulk full-replaces facilities.

Headers

X-Delogue-Api
string

Body

id
string
required

Unique identifier of the facility to update, formatted as a GUID. Required to match each item in the bulk request.

name
string

Display name of the facility. Required.

address
string

Street address of the facility. Optional.

zipCode
string

Postal or ZIP code of the facility. Optional.

city
string

City where the facility is located. Optional.

stateOrRegion
null | string

State, province, or region within the country. Sending null clears any existing value.

countryCode
string

ISO 3166-1 alpha-2 country code, e.g. CN or PT. Required.

latitude

Geographic latitude of the facility in decimal degrees. Sending null clears any existing value.

longitude

Geographic longitude of the facility in decimal degrees. Sending null clears any existing value.

mid
null | string

Manufacturer Identification Number used as a customs identifier. Sending null clears any existing value.

relationType
null | enum<string>

Classifies the facility's role in the supply chain. Sending null clears the relation type.

Available options:
distributor,
itemSupplier,
sourcingAgency,
styleSupplier
state
enum<string>

Target lifecycle state for the facility. Setting it to deleted triggers a soft-delete.

Available options:
active,
archived,
deleted
processTypeIds
null | integer<int64>[]

Process type identifiers to assign. Null or omitted keeps the current assignments; a non-empty list replaces them, and at least one is required.

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
null | object[]
required

The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value.