CallOffReleaseRules

Get call-off release rule by code

Gets a call-off release rule by its unique code.

get/commerce/rules/calloffrelease/{code}

Request

  • Base URL
    https://t1000000.sb.usc1.gcp.kibocommerce.com/api
  • URL
    https://t1000000.sb.usc1.gcp.kibocommerce.com/api/commerce/rules/calloffrelease/{code}
  • Auth
    HTTP bearer

Path parameters

codestring required

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Response

OK

callOffOrderRulesstring[] nullable

Referenced Call-Off-Order Rule codes. Max 1 entry. At least one of ProductRules, CustomerRules, or CallOffOrderRules must be non-empty (FR-007, FR-008).

codestring nullable

Unique identifier. Auto-generated on create if not supplied. Immutable after creation. Max 30 characters; must match GeneralAlphaNumericCharactersRegex (FR-005, FR-016).

customerRulesstring[] nullable

Referenced Customer Rule codes. Max 1 entry (FR-007, FR-008).

daysBeforeShipDateinteger

Days before the ship date within which this rule applies. Inclusive [0, 365] (FR-015).

descriptionstring nullable

Optional description. Max 500 characters (FR-003).

enabledboolean nullable

Whether the rule is active. Defaults to true on insert (FR-003, FR-011).

metaDataunknown
minimumFillRateinteger

Minimum fill rate threshold [0, 100] (integer percentage). 0 is valid (FR-027).

namestring nullable

Display name. Required. Max 200 characters (FR-003).

rankinteger

Priority rank, unique per (TenantId, MasterCatalogId). Auto-assigned to MAX(Rank)+1 when omitted or ≤0 on create (FR-006, FR-017).

sortAttributestring nullable

Optional tiebreaker attribute name used by the downstream call-off release engine. Max 50 characters. null, absent, and empty are all accepted (FR-026).

validForAllSitesboolean nullable

When true the rule applies to all tenant sites; ValidSites is ignored (FR-022).

validSitesinteger[] nullable

Site IDs this rule applies to. Each must be tenant-owned (FR-007, FR-022).

Changes

No recorded changes to this operation across all 1 revision of this API.