commerce/returns/shipments

Use the Return Shipments subresource to manage shipments for a return replacement.

JSON Example

Shipment Properties

Property Description
auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

cost

type: decimal

The cost of the product to the retailer, as specified through API or using the Cost field of the Product editor in Admin. This is not the price that the shopper sees on the storefront (which is usually higher).

For price lists entries, this property specifies the cost of the product if costMode is set to Overridden.

currencyCode

type: string

The localized currency code for the monetary amount.

destinationAddress

type: contact

The physical address orders are sent to as a shipping destination. This address may contain multiple lines, city, state/province, country, and zip/postal code. The destination is used to calculate shipping costs.

contact.address

type: address

Address information to supply for a contact.

contact.address.address1

type: string

Physical or mailing address line one. Usually includes the street number and street name or it could be a P.O. Box. Max length: 200.

contact.address.address2

type: string

Physical or mailing address line two. Usually supplements the main street address with apartment, floor, suite, building, or unit information. Max length: 200.

contact.address.address3

type: string

Physical or mailing address line three. Max length: 200.

contact.address.address4

type: string

Physical or mailing address line four. Max length: 200.

contact.address.addressType

type: string

The type of address, which is commercial or residential.

contact.address.cityOrTown

type: string

The entered city or town for the address.

contact.address.countryCode

type: string

The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.

contact.address.isValidated

type: bool

Indicates if the address has been validated. If true, the address has been verified by an address validation service.

contact.address.postalOrZipCode

type: string

The entered zip or postal code for an address.

contact.address.stateOrProvince

type: string

The entered state or province for an address.

contact.companyOrOrganization

type: string

The entered company or organization name entered for a customer account.

contact.email

type: string

The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists.

contact.firstName

type: string

The full first name of a customer or contact name.

contact.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

contact.lastNameOrSurname

type: string

The full last name or surname of a customer or contact name.

contact.middleNameOrInitial

type: string

Character string of the middle name or initial for the customer.

contact.phoneNumbers

type: phone

List of phone numbers associated with the customer account contact. The phone numbers include area codes.

contact.phone.home

type: string

Home phone number.

contact.phone.mobile

type: string

Mobile phone number.

contact.phone.work

type: string

Work phone number.

id

type: string

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

originAddress

type: contact

The physical address from which the order or shipment will ship.

contact.address

type: address

Address information to supply for a contact.

contact.address.address1

type: string

Physical or mailing address line one. Usually includes the street number and street name or it could be a P.O. Box. Max length: 200.

contact.address.address2

type: string

Physical or mailing address line two. Usually supplements the main street address with apartment, floor, suite, building, or unit information. Max length: 200.

contact.address.address3

type: string

Physical or mailing address line three. Max length: 200.

contact.address.address4

type: string

Physical or mailing address line four. Max length: 200.

contact.address.addressType

type: string

The type of address, which is commercial or residential.

contact.address.cityOrTown

type: string

The entered city or town for the address.

contact.address.countryCode

type: string

The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.

contact.address.isValidated

type: bool

Indicates if the address has been validated. If true, the address has been verified by an address validation service.

contact.address.postalOrZipCode

type: string

The entered zip or postal code for an address.

contact.address.stateOrProvince

type: string

The entered state or province for an address.

contact.companyOrOrganization

type: string

The entered company or organization name entered for a customer account.

contact.email

type: string

The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists.

contact.firstName

type: string

The full first name of a customer or contact name.

contact.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

contact.lastNameOrSurname

type: string

The full last name or surname of a customer or contact name.

contact.middleNameOrInitial

type: string

Character string of the middle name or initial for the customer.

contact.phoneNumbers

type: phone

List of phone numbers associated with the customer account contact. The phone numbers include area codes.

contact.phone.home

type: string

Home phone number.

contact.phone.mobile

type: string

Mobile phone number.

contact.phone.work

type: string

Work phone number.

packageIds

type: list of string

Array list of unique IDs of packages in a shipment planned for or finished a shipping fulfillment action.

shippingMethodCode

type: string

The code associated with a carrier's shipping method service type, used during fulfillment of packages and shipments. Service type codes include a prefix that indicates the carrier. For example: FEDEX_INTERNATIONAL_STANDARD and UPS_GROUND.

If using a custom rate, this property corresponds to the Custom Code field in Admin when you navigate to System > Shipping > Carriers, and then click on an existing rate or on Create New Custom Rate.

signatureRequired

type: bool

If true, a shopper signature is required to deliver this shipment.

trackingNumber

type: string

Tracking number for the package or shipment, supplied by the shipping carrier to track the shipment until fulfillment completes. The tracking number format may differ between carriers.

Operations

Operation Name Request URI Description
CreatePackageShipments POST %7breturnId%7d%2fshipments

Creates a shipment from one or more packages associated with a return replacement.

DeleteShipment DELETE %7breturnId%7d%2fshipments%2f%7bshipmentId%7d

Deletes a shipment for a return replacement.

GetShipment GET %7breturnId%7d%2fshipments%2f%7bshipmentId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified return replacement shipment.