ccrz__E_OrderShipment__c

Compatibility

This reference applies to:

API Usage

Class used with: ccrz.ccApiOrder

Fetch sizing: The ccrz.ccApiOrder.fetch method returns the EOrderShipmentsS and EOrderShipmentItemsS related lists when you request at least a large data size for the ccrz.ccApiOrder.ENTITYNAME key in your input data:

ccrz.ccApi.SIZING => new Map<String, Object> {
    ccrz.ccApiOrder.ENTITYNAME => new Map<String, Object> {
        ccrz.ccApi.SZ_DATA => ccrz.ccApi.SZ_L
    }
}

To request this related list even with a smaller data size, add the ccrz.ccApi.SZ_REL key to your input map:

ccrz.ccApi.SIZING => new Map<String, Object> {
        ccrz.ccApiOrder.ENTITYNAME => new Map<String, Object> {
            ccrz.ccApi.SZ_DATA => ccrz.ccApi.SZ_S,
            ccrz.ccApi.SZ_REL => New List<String>{'E_OrderShipments__r'}
        }
    }

Each record returned in this list always includes the same fields, regardless of the requested data size.

Fields

Carrier

The shipping service provider.

Usage	Field Name	Data Type
Input on object	ccrz__Carrier__c	Picklist
Input or output with API (with any data size)	carrier	String

Delivery Date

The expected date when the carrier delivers the shipment.

Usage	Field Name	Data Type
Input on object	ccrz__DeliveryDate__c	Date
Input or output with API (with any data size)	deliveryDate	Date

Order

The order that the shipment applies to.

Usage	Field Name	Data Type
Input on object	ccrz__Order__c	Master-Detail Relationship (ccrz__E_Order__c)
Input or output with API (with any data size)	order	ID

Order Shipment ID

A unique ID that associates the record with an external system.

Usage	Field Name	Data Type
Input on object	ccrz__OrderShipmentId__c	Text (128)
Input or output with API (with any data size)	orderShipmentId	String

Order Shipment Number

A unique, automatically assigned ID for the record.

Usage	Field Name	Data Type
Input on object	Name	Auto Number
Input or output with API (with any data size)	sfdcName	String

Shipment Date

The date when the carrier sends the shipment.

Usage	Field Name	Data Type
Input on object	ccrz__ShipmentDate__c	Date
Input or output with API (with any data size)	shipmentDate	Date

Shipping Method

The shipping method selected during checkout.

Usage	Field Name	Data Type
Input on object	ccrz__ShippingMethod__c	Text (255)
Input or output with API (with any data size)	shippingMethod	String

Tracking Number

A unique ID for tracking the shipment. To fulfill the tracking, pass this value to the shipping service provider.

Usage	Field Name	Data Type
Input on object	ccrz__TrackingNo__c	Text (255)
Input or output with API (with any data size)	trackingNo	String

Deprecated Fields

The following fields exist on the object but aren't used by the managed package. Don't use these fields in any development or customization.

Related Lists

The ccrz.ccApiOrder.fetch method returns the following related list for each ccrz__E_OrderShipment__c record:

EOrderShipmentItemsS

List<Map<String, Object>> of ccrz__E_OrderShipmentItem__c.