Skip to main content

MGCLatticeSalesPackingSlipCancelRequestContract

Request contract for canceling a posted sales packing slip (cancelSalesPackingSlip): the sales order (or its external key), the packing slip to cancel (optional: without it, the order's only packing slip that can be canceled), the preview flag (always refused) and the common envelope fields.

Methods​

construct​

Creates a new instance of the MGCLatticeSalesPackingSlipCancelRequestContract class.

  • Visibility: public
  • Returns: MGCLatticeSalesPackingSlipCancelRequestContract A new MGCLatticeSalesPackingSlipCancelRequestContract instance.

No parameters.

parmCorrelationId​

Gets or sets the correlation identifier for tracing the request across systems.

  • Visibility: public
  • Returns: Guid The CorrelationId value.
NameTypeOptionalDescription
_correlationIdGuidYesThe CorrelationId value.

parmRequestId​

Gets or sets the unique request identifier for idempotency.

  • Visibility: public
  • Returns: Guid The RequestId value.
NameTypeOptionalDescription
_requestIdGuidYesThe RequestId value.

parmLegalEntityId​

Gets or sets the legal entity (company) of the sales order.

  • Visibility: public
  • Returns: DataAreaId The LegalEntityId value.
NameTypeOptionalDescription
_legalEntityIdDataAreaIdYesThe LegalEntityId value.

parmUserContext​

Gets or sets the calling system's user context (informational).

  • Visibility: public
  • Returns: UserId The UserContext value.
NameTypeOptionalDescription
_userContextUserIdYesThe UserContext value.

parmSalesOrderId​

Gets or sets the sales order whose packing slip is canceled (or send SalesOrderIdExternalKey).

  • Visibility: public
  • Returns: SalesId The SalesOrderId value.
NameTypeOptionalDescription
_salesOrderIdSalesIdYesThe SalesOrderId value.

parmPackingSlipId​

Gets or sets the packing slip to cancel. Optional: without it the order's only packing slip that can be canceled is canceled, and an order with several is refused.

  • Visibility: public
  • Returns: PackingSlipId The PackingSlipId value.
NameTypeOptionalDescription
_packingSlipIdPackingSlipIdYesThe PackingSlipId value.

parmPreviewMode​

Gets or sets preview mode. The operation has no preview, so a request with PreviewMode set is refused.

  • Visibility: public
  • Returns: boolean The PreviewMode value.
NameTypeOptionalDescription
_previewModebooleanYesThe PreviewMode value.

parmExternalSystem​

Gets or sets the external system whose keys the request's external key members hold.

  • Visibility: public
  • Returns: MGCLatticeExternalSystemId The ExternalSystem value.
NameTypeOptionalDescription
_externalSystemMGCLatticeExternalSystemIdYesThe ExternalSystem value.

parmSalesOrderIdExternalKey​

Gets or sets the external system's key of the sales order, in place of SalesOrderId.

  • Visibility: public
  • Returns: MGCLatticeExternalKey The SalesOrderIdExternalKey value.
NameTypeOptionalDescription
_salesOrderIdExternalKeyMGCLatticeExternalKeyYesThe SalesOrderIdExternalKey value.