Options
All
  • Public
  • Public/Protected
  • All
Menu

Set (or overwrite) the partner-side external order id for a specific job. Triggered by S4C via the /v3/commands/s4c/your-order-id endpoint and consumed in jobs-service, which writes it to Job.extPartnerId (column partner_eid__c).

Exactly one of jobApiId, invoicingEid, or gidOrderNumber must be provided to identify the target job. yourOrderID is the value being set, so it can't be used as a lookup key here.

Hierarchy

Index

Constructors

Properties

_cid: string

Command ID. This can be any string, and it's up to the api integrator to ensure uniqueness.

_metadata?: {}

Arbitrary metadata set by the api integrator. Keys must start with 'ext-'

Type declaration

  • [key: string]: string

The command type

_v: string

Command format version / API version

gidOrderNumber?: string
invoicingEid?: string
jobApiId?: string
yourOrderID: string

Generated using TypeDoc