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:
MGCLatticeSalesPackingSlipCancelRequestContractA new MGCLatticeSalesPackingSlipCancelRequestContract instance.
No parameters.
parmCorrelationId
Gets or sets the correlation identifier for tracing the request across systems.
- Visibility:
public - Returns:
GuidThe CorrelationId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_correlationId | Guid | Yes | The CorrelationId value. |
parmRequestId
Gets or sets the unique request identifier for idempotency.
- Visibility:
public - Returns:
GuidThe RequestId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_requestId | Guid | Yes | The RequestId value. |
parmLegalEntityId
Gets or sets the legal entity (company) of the sales order.
- Visibility:
public - Returns:
DataAreaIdThe LegalEntityId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_legalEntityId | DataAreaId | Yes | The LegalEntityId value. |
parmUserContext
Gets or sets the calling system's user context (informational).
- Visibility:
public - Returns:
UserIdThe UserContext value.
| Name | Type | Optional | Description |
|---|---|---|---|
_userContext | UserId | Yes | The UserContext value. |
parmSalesOrderId
Gets or sets the sales order whose packing slip is canceled (or send SalesOrderIdExternalKey).
- Visibility:
public - Returns:
SalesIdThe SalesOrderId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_salesOrderId | SalesId | Yes | The 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:
PackingSlipIdThe PackingSlipId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_packingSlipId | PackingSlipId | Yes | The PackingSlipId value. |
parmPreviewMode
Gets or sets preview mode. The operation has no preview, so a request with PreviewMode set is refused.
- Visibility:
public - Returns:
booleanThe PreviewMode value.
| Name | Type | Optional | Description |
|---|---|---|---|
_previewMode | boolean | Yes | The PreviewMode value. |
parmExternalSystem
Gets or sets the external system whose keys the request's external key members hold.
- Visibility:
public - Returns:
MGCLatticeExternalSystemIdThe ExternalSystem value.
| Name | Type | Optional | Description |
|---|---|---|---|
_externalSystem | MGCLatticeExternalSystemId | Yes | The ExternalSystem value. |
parmSalesOrderIdExternalKey
Gets or sets the external system's key of the sales order, in place of SalesOrderId.
- Visibility:
public - Returns:
MGCLatticeExternalKeyThe SalesOrderIdExternalKey value.
| Name | Type | Optional | Description |
|---|---|---|---|
_salesOrderIdExternalKey | MGCLatticeExternalKey | Yes | The SalesOrderIdExternalKey value. |