6 Outbound Integration

This chapter provides information about the following outbound integration processes:

Integration with Customer Order System

Integration of Direct From Vendor Receipts

Integration of Direct From Vendor Return

Integration of Inventory Movements

Integration with Manifesting Systems

Integration for Notifications

Integration of Pre-Shipment Notification

Integration for Sales Forecast

Integration of Shipments

Integration of Stock Count Schedules

Integration for Store Order

Integration for Ticket Printing

Integration of Transfers

Integration of Transfer Receipts

Integration of Order Available Stock On Hand

Integration with Customer Order System

SOAP Service: CustomerOrderAddressService

When shipping to customer during the fulfillment order workflow, EICS retrieves the address for the order delivery from an external order managements system. When viewing delivery address information within the client application, it also retrieves it from an external system. The web service is defined to connect to an OrderManagementService.

Service Operation	Description
queryCustomerOrderAddress	Retrieves detailed address information for the order and customer information passed to it.

SOAP Service: CustomerOrderService

This service connects to OrderManagementService to manage customer orders. It includes operations to create a customer order, query for customer orders, pickup/cancel items from a customer order and return items from customer orders.

Service Operation	Description
requestNewCustomerOrderId	Requests new customer order Id.
cancelNewCustomerOrderId	Cancels the new customer order id.
createCustomerOrder	Creates customer order.
queryCustomerOrder	Queries the customer order present in the system.
PickupCustomerOrderItems	Pickup items from the customer order.
ReturnCustomerOrderItems	Returns items from the customer order.
UpdateReceipt	Updates the receipt of customer order.

REST Service: Fulfillment Order Address (External)

When shipping to customer during the fulfillment order workflow, EICS retrieves the address for the order delivery from an external order managements system. When viewing delivery address information within the client application, it also retrieves it from an external system.

This service must be implemented by an external system that will provide the customer address for a particular customer order. SIOCS does not store customer information and retrieves it from this external endpoint just prior to shipping.

Order Address

This section describes the Order Address API. This API retrieve the address of the customer for a particular order.

Method

POST

URL

/orderaddress

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the order and customer in order to retrieve the proper address.

Example Value

{
  "customerOrderNo": "111222333",
  "fulfillmentOrderNo": "444555666",
  "storeId": 5000
}

Schema — FulfillmentOrderAddressCriticalExtIdo

Table 6-1 FulfillmentOrderAddressCriticalExtIdo— Object

Element Name	Required	Data Type/Example	Description
customerOrderNo	NA	string($text128) example: 111222333	The customer order number.
fulfillmentOrderNo	NA	string($text128) example: 444555666	The fulfillment order number.
storeId	NA	number($int10) example: 5000	The identifier of the store that will fulfill the order.

Responses

This section describes the responses of the Order Address API.

Response Code: 200

The request has been successful.

The media type is application/json.

Example Value

[
  {
    "billingAddress1": "Box 110",
    "billingAddress2": "Apartment Block 2534",
    "billingAddress3": "4th Avenue North",
    "billingCity": "Blaketon",
    "billingState": "MN",
    "billingCountryCode": "USA",
    "billingCounty": "Bernard",
    "billingCompanyName": "Holdings Consolidated",
    "billingEmailAddress": "[e-mail]",
    "billingFirstName": "Janice",
    "billingLastName": "Smith",
    "billingPhoneNumber": "555-765-2452",
    "billingPhoneticFirst": "jan-iss",
    "billingPhoneticLast": "Smith",
    "billingPostalCode": "55555",
    "customerNumber": "A123B44",
    "deliveryAddress1": "Box 110",
    "deliveryAddress2": "Apartment Block 2534",
    "deliveryAddress3": "4th Avenue North",
    "deliveryCity": "Blaketon",
    "deliveryState": "MN",
    "deliveryCountryCode": "USA",
    "deliveryCounty": "Bernard",
    "deliveryPostalCode": "55555",
    "deliveryCompanyName": "Holdings Consolidated",
    "deliveryEmailAddress": "[e-mail]",
    "deliveryFirstName": "Janice",
    "deliveryLastName": "Smith",
    "deliveryPhoneNumber": "555-765-2452",
    "deliveryPhoneticFirst": "jan-iss",
    "deliveryPhoneticLast": "smith",
    "deliveryPreferredName": "Jan"
  }
]

Schema — FulfillmentOrderAddressExtIdo

Table 6-2 FulfillmentOrderAddressExtIdo— Object

Element Name	Required	Data Type/Example	Description
billingAddress1	NA	string($text240) example: Box 110	The first billing address line.
billingAddress2	NA	string($text240) example: Apartment Block 2534	The second billing address line.
billingAddress3	NA	string($text240) example: 4th Avenue North	The third billing address line.
billingCity	NA	string($text120) example: Blaketon	The billing address city name.
billingState	NA	string($text3) example: MN	The billing address state code.
billingCountryCode	NA	string($text3) example: USA	The billing address country code.
billingCounty	NA	string($text250) example: Bernard	The billing address county name.
billingCompanyName	NA	string($text120) example: Holdings Consolidated	The billing address company name.
billingEmailAddress	NA	string($text100) example: [e-mail]	The billing contact email address.
billingFirstName	NA	string($text120) example: Janice	The billing contact first name.
billingLastName	NA	string($text120) example: Smith	The billing contact last name.
billingPhoneNumber	NA	string($text20) example: 555-765-2452	The billing contact phone number.
billingPhoneticFirst	NA	string($text120) example: jan-iss	The billing contact phonetic spelling of first name.
billingPhoneticLast	NA	string($text120) example: Smith	The billing contact phonetic spell of last name.
billingPostalCode	NA	string($text30) example: 55555	The billing address postal code.
customerNumber	NA	string($text14) example: A123B44	The customer number of the customer who placed the order.
deliveryAddress1	NA	string($text240) example: Box 110	The first delivery address line.
deliveryAddress2	NA	string($text240) example: Apartment Block 2534	The second delivery address line.
deliveryAddress3	NA	string($text240) example: 4th Avenue North	The third delivery address line.
deliveryCity	NA	string($text120) example: Blaketon	The delivery address city name.
deliveryState	NA	string($text3) example: MN	The delivery address state code.
deliveryCountryCode	NA	string($text3) example: USA	The delivery address country code.
deliveryCounty	NA	string($text250) example: Bernard	The delivery address county name.
deliveryPostalCode	NA	string($text30) example: 55555	The delivery address postal code.
deliveryCompanyName	NA	string($text120) example: Holdings Consolidated	The company name at the delivery address.
deliveryEmailAddress	NA	string($text100) example: [e-mail]	The email address of the delivery contact.
deliveryFirstName	NA	string($text120) example: Janice	The first name of the delivery contact.
deliveryLastName	NA	string($text120) example: Smith	The last name of the delivery contact.
deliveryPhoneNumber	NA	string($text20) example: 555-765-2452	The phone number of the delivery contact.
deliveryPhoneticFirst	NA	string($text120) example: jan-iss	The phonetic spelling of the first name of the delivery contact.
deliveryPhoneticLast	NA	string($text120) example: smith	The phonetic spelling of the last name of the delivery contact.
deliveryPreferredName	NA	string($text120) example: Jan	The preferred name of the delivery contact.

REST Service: Customer Fulfillment Order Status (External)

This service must be implemented by an external system that wants to receive notices from EICS about that state of customer fulfillment orders.

Order Query

This operations queries an order. It retrieves real-time order from the order management system to verify prior to shipping.

Method

POST

URL

/orderstatus/query

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the fulfillment order to be queried.

Example Value

{
  "customerOrderId": "222345666",
  "fulfillmentOrderId": "76544400",
  "storeId": 1234
}

Schema — FulfillmentOrderCriteriaIdo

Table 6-3 FulfillmentOrderCriteriaIdo— Object

Element Name	Required	Data Type/Example	Description
customerOrderId	Yes	string($text128) example: 222345666	The customer order number (from the external ordering system).
fulfillmentOrderId	NA	string($text128) example: 76544400	The fulfillment order number (from the external ordering system).
storeId	Yes	number($int10) example: 1234	The identifier of the store at which this order will be fulfilled.

Responses

This section describes the responses of the Order Query API.

Response Code: 200

The request has been successful.

The media type is application/json.

Example Value

[
  {
    "customerOrderId": "222345666",
    "lineItems": [
      {
        "itemId": "55001234",
        "completedQuantity": 2,
        "canceledQuantity": 10
      }
    ]
  }
]

Schema — FulfillmentOrderExtIdo

Table 6-4 FulfillmentOrderExtIdo— Object

Element Name	Required	Data Type/Example	Description
customerOrderId	Yes	string($text128) example: 222345666	The customer order number (from the external ordering system).
lineItems	NA	object	A collection of line items on the fulfillment order.

Table 6-5 FulfillmentOrderItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	Yes	string($text25) example: 55001234	The SKU level item identifier.
completedQuantity	NA	number($int10) example: 2	The amount of the item ordered that has been completed.
canceledQuantity	NA	number($decimal(12,4)) example: 10	The amount of the item ordered that has been canceled.

Order Accepted

This operation will be accessed when a new fulfillment order has been accepted by the store, sending information about the quantities accepted.

Method

POST

URL

/orderstatus/accept

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the fulfillment order that was accepted.

Example Value

{
  "customerOrderId": "222345666",
  "fulfillmentOrderId": "76544400",
  "storeId": 1234,
  "lineItems": [
    {
      "itemId": "55001234",
      "lineNumber": 2,
      "quantityOrdered": 10
    }
  ]
}

Schema — FulfillmentOrderAcceptExtIdo

Table 6-6 FulfillmentOrderAcceptExtIdo— Object

Element Name	Required	Data Type/Example	Description
customerOrderId	Yes	string($text128) example: 222345666	The customer order number (from the external ordering system).
fulfillmentOrderId	NA	string($text128) example: 76544400	The fulfillment order number (from the external ordering system).
storeId	Yes	number($int10) example: 1234	The identifier of the store at which this order will be fulfilled.
lineItems	Yes	object	A collection of accepted line items on the fulfillment order.

Table 6-7 FulfillmentOrderAcceptItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	Yes	string($text25) example: 55001234	The SKU level item identifier.
lineNumber	NA	number($int10) example: 2	The line number of the fulfillment order this item is fulfilling.
quantityOrdered	Yes	number($decimal(12,4)) example: 10	The quantity accepted on this line item.

Responses

This section describes the responses of the Order Accept API.

Response Code: 204

No content

Order Rejected

This service will be accesses when a new fulfillment order has been rejected by the store.

Method

POST

URL

/orderstatus/reject

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the fulfillment order that was rejected.

Example Value

{
  "customerOrderId": "222345666",
  "fulfillmentOrderId": "76544400",
  "storeId": 1234
}

Schema — FulfillmentOrderRejectIdo

Table 6-8 FulfillmentOrderRejectIdo— Object

Element Name	Required	Data Type/Example	Description
customerOrderId	Yes	string($text128) example: 222345666	The customer order number (from the external ordering system).
fulfillmentOrderId	NA	string($text128) example: 76544400	The fulfillment order number (from the external ordering system).
storeId	Yes	number($int10) example: 1234	The identifier of the store at which this order will be fulfilled.

Responses

This section describes the responses of the Order Rejected API.

Response Code: 204

No content

Order Status

This service will be accessed when the state of an order changes sending complete details about the fulfillment order. This occurs when order quantity reservations change, when picking occurs, when reverse picking occurs, and when a delivery is shipped.

Method

POST

URL

/orderstatus/status

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the fulfillment order.

Example Value

{
  "orderId": 11111,
  "customerOrderId": "222345666",
  "fulfillmentOrderId": "76544400",
  "storeId": 1234,
  "customerId": "JXA244443",
  "orderType": 1,
  "deliveryType": 1,
  "status": 1,
  "orderDate": "2025-02-07T10:34:03.411Z",
  "releaseDate": "2025-02-07T10:34:03.411Z",
  "deliveryDate": "2025-02-07T10:34:03.411Z",
  "carrierId": 4500674,
  "carrierServiceId": 573314534,
  "allowPartialDelivery": true,
  "deliveryCharge": 4500674,
  "deliveryChargeCurrency": "USD",
  "holdLocation": "Pickup Desk",
  "orderComments": "Customer will arrive by 2pm.",
  "underReview": false,
  "quickFlow": true,
  "deliveryComments1": "First line.",
  "deliveryComments2": "Second line.",
  "deliveryComments3": "Third line.",
  "customerArrivalDate": "2025-02-07T10:34:03.411Z",
  "createDate": "2025-02-07T10:34:03.411Z",
  "updateDate": "2025-02-07T10:34:03.411Z",
  "activityType": 1,
  "systemCode": "INV",
  "lineItems": [
    {
      "lineId": 333444,
      "itemId": "55001234",
      "substituteLineId": 5600043,
      "lineNumber": 2,
      "preferredUom": "KG",
      "comments": "Item packaging slightly damaged.",
      "quantityOrdered": 10,
      "quantityPicked": 6,
      "quantityDelivered": 2,
      "quantityCanceled": 2,
      "quantityReserved": 8,
      "allowSubstitution": true,
      "price": 4500674,
      "priceCurrency": "USD",
      "createDate": "2025-02-07T10:34:03.411Z",
      "updateDate": "2025-02-07T10:34:03.411Z"
    }
  ]
}

Schema — FulfillmentOrderStatusExtIdo

Table 6-9 FulfillmentOrderStatusExtIdo— Object

Element Name	Required	Data Type/Example	Description
orderId	NA	number($int12) example: 11111	The unique identifier of the fulfillment order.
customerOrderId	NA	string($text128) example: 222345666	The customer order number (from the external ordering system).
fulfillmentOrderId	NA	string($text128) example: 76544400	The fulfillment order number (from the external ordering system).
storeId	NA	number($int10) example: 1234	The identifier of the store at which this order will be fulfilled.
customerId	NA	string($text14) example: JXA244443	The identifier of the customer for this fulfillment order.
orderType	NA	integer($int4) example: 1	The order type of the customer order. Valid values are: 1 - Layaway 2 - Pickup and Delivery 3 - Customer Order 4 - Pending Purchase 5 - Special Order 6 - Web Order 7 - On Hold Enum: [ 1, 2, 3, 4, 5, 6, 7 ]
deliveryType	NA	integer($int4) example: 1	The delivery type of the customer order. Valid values are: 1 - Customer Pickup 2 - Ship To Store 3 - Layaway 4 - On Hold 5 - POS Order Enum: [ 1, 2, 3, 4, 5 ]
status	NA	integer($int4) example: 1	The current status of the customer order. Value values are: 1 - New 2 - In Progress 3 - Completed 4 - Canceled 5 - Reverse Pick 6 - Pick In Progress 7 - Delivery In Progress 8 - Ready To Ship 9 - Ready For Pickup 10 - Picking Required 11 - Under Review Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
orderDate	NA	string($date-time)	The date the customer placed the order.
releaseDate	NA	string($date-time)	The date in which the order must be shipped by the store or picked up in the store.
deliveryDate	NA	string($date-time)	The date in which the order is to be delivered.
carrierId	NA	integer($int10) example: 4500674	The identifier of the carrier who will deliver the order.
carrierServiceId	NA	integer($int10) example: 573314534	The identifier of the carrier service used for the delivery.
allowPartialDelivery	NA	boolean example: true	True indicates delivery can occur without all items being available and ready. False indicates all items must be shipped in the delivery.
deliveryCharge	NA	number($decimal(12,4)) example: 4500674	The cost of shipment of this order.
deliveryChargeCurrency	NA	string($text3) example: USD	The currency of the delivery charge value.
holdLocation	NA	string($text128) example: Pickup Desk	Descripton of where the order is being held for pickup or delivery.
orderComments	NA	string($text2000) example: Customer will arrive by 2pm.	Comments entered in the external system for the order.
underReview	NA	boolean example: false	True indicates that the fulfilling system needs to delay either shipping or fulfilling the order until this flag is cleared.
quickFlow	NA	boolean example: true	True indicates the customer order is fulfilled using the quick flow JET mobile process. False indicates the standard process was used.
deliveryComments1	NA	string($text128) example: First line.	The first line of delivery comments.
deliveryComments2	NA	string($text128) example: Second line.	The second line of delivery comments.
deliveryComments3	NA	string($text128) example: Third line.	The third line of delivery comments.
customerArrivalDate	NA	string($date-time)q	The date that the customer arrived for pickup.
createDate	NA	string($date-time)	The date the fulfillment order was created in SIOCS.
updateDate	NA	string($date-time)	The date the fulfillment order was last updated in SIOCS.
activityType	NA	integer($int4) example: 1	1 - Delivery Dispatch 2 - Order Pick 3 - Order Reservation 4 - Order Reverse Pick Enum: [ 1, 2, 3, 4 ]
systemCode	NA	string($text10) example: INV	A system code indicating the system of origin of this content.
lineItems	NA	object	A collection of line items on the fulfillment order.

Table 6-10 FulfillmentOrderStatusItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
lineId	NA	number($int12) example: 333444	The unique identifier of the line item.
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
substituteLineId	NA	number($int12) example: 5600043	The identifier of a line item that this item has been substituted for.
lineNumber	NA	number($int10) example: 2	The line number of the fulfillment order this item is fulfilling.
preferredUom	NA	string($text4) example: KG	The preferred unit of measure the item quantities should be processed or displayed in.
comments	NA	string($text2000) example: Item packaging slightly damaged.	Comments from an external system associated to this item.
quantityOrdered	NA	number($decimal(12,4)) example: 10	The quantity ordered on this line item.
quantityPicked	NA	number($decimal(12,4)) example: 6	The quantity picked for this line item.
quantityDelivered	NA	number($decimal(12,4)) example: 2	The quantity delivered to date on this line item.
quantityCanceled	NA	number($decimal(12,4)) example: 2	The quantity canceled on this line item.
quantityReserved	NA	number($decimal(12,4)) example: 8	The quantity reserved for this line item.
allowSubstitution	NA	boolean example: true	True indicates a substitution is allowed for this item, false indicates it is not.
price	NA	number($decimal(20,4)) example: 4500674	The amount of the price of the item.
priceCurrency	NA	string($text3) example: USD	The currency of the price of the item.
createDate	NA	string($date-time)	The date the order item was created in SIOCS.
updateDate	NA	string($date-time)	The date the order item was last updated in SIOCS.

Responses

This section describes the responses of the Order Status API.

Response Code: 204

No content

Integration of Direct From Vendor Receipts

EICS publishes out a vendor delivery receipt (DCS receipt) to an external endpoint when the delivery is confirmed. The service must be configured on the external services administration screen.

REST Service: Vendor Delivery Receipt (External)

This service publishes out the information about a vendor delivery receipt (DSD Receipt) to an external endpoint. This occurs when the vendor delivery receipt is confirmed.

Receipt Confirmed

A receipt information is sent via this operation when a vendor delivery receipt is confirmed.

Method

POST

URL

/dsdreceipts

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the vendor delivery receipt that was confirmed.

Example Value

{
  "supplierId": 5510,
  "storeId": 5000,
  "receiptNumber": "A3DA",
  "invoiceNumber": "1004728342",
  "invoiceDate": "2025-02-11T14:42:26.122Z",
  "receiptDate": "2025-02-11T14:42:26.122Z",
  "deliveryType": 1,
  "originatingCountryCode": "CAN",
  "currencyCode": "CAD",
  "carrierCode": "SHP",
  "containers": [
    {
      "cartonId": 55001234,
      "externalCartonId": "234342",
      "trackingNumber": "863413410",
      "receiptDate": "2025-02-11T14:42:26.122Z",
      "adjusted": false,
      "missing": false,
      "items": [
        {
          "itemId": "55001234",
          "vendorProductNumber": "55001234",
          "quantityExpected": 10,
          "quantityReceived": 10,
          "quantityDamaged": 5,
          "caseSize": 100,
          "purchaseOrderId": 7444567333,
          "externalPurchaseOrderId": "55001234",
          "customerOrderNumber": "143523465425",
          "fulfillmentOrderNumber": "134314",
          "unitCostValue": 11.5,
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ]
        }
      ]
    }
  ]
}

Schema — VendorDeliveryReceiptExtIdo

Table 6-11 VendorDeliveryReceiptExtIdo — Object

Element Name	Required	Data Type/Example	Description
supplierId	NA	number($int10) example: 5510	The identifier of the supplier that shipped the goods.
storeId	NA	number($int10) example: 5000	The identifier of the store receiving the goods.
receiptNumber	NA	number($int12) example: A3DA	The receipt number of the delivery.
invoiceNumber	NA	string($text128) example: 1004728342	The invoice number of the delivery.
invoiceDate	NA	string($date-time)	The date of the invoice.
receiptDate	NA	string($date-time)	The date the delivery was received.
deliveryType	NA	number($int2) example: 1	The type of delivery. Valid values are: 1 - ASN 2 - PO 3 - DEX-NEX 4 - Manual Enum: [ 1, 2, 3, 4 ]
originatingCountryCode	NA	string($text3) example: CAN	The country code of the country of origin.
currencyCode	NA	string($text3) example: CAD	The currency code of the delivery.
carrierCode	NA	string($text4) example: SHP	The carrier code of the delivery carrier.
containers	NA	object	A collection of containers on the delivery.

Table 6-12 VendorDeliveryReceiptContainerExtIdo — Object

Element Name	Required	Data Type/Example	Description
cartonId	NA	number($int12) example: 55001234	The internal system container identifier.
externalCartonId	NA	string($text128) example: 234342	An external system carton identifier for reference.
trackingNumber	NA	string($text124) example: 863413410	The tracking number of the container.
receiptDate	NA	string($date-time)	The date the container was received.
adjusted	NA	boolean example: false	True if the carton is adjusted from a previous receipt, false if it is the first receipt of this container.
missing	NA	boolean example: false	True if the carton is missing from the receipt, false if it is received.
items	NA	object	A collection of line items within the container.

Table 6-13 VendorDeliveryReceiptItemExtIdo — Object

Element Name	Required	Data Type/Example	Description
itemId		string($text25) example: 55001234	The SKU level item identifier.
vendorProductNumber		string($text256) example: 55001234	The vendor product number of the item/sku.
quantityExpected		number($decimal(20,4)) example: 10	The quantity originally expected to be received.
quantityReceived		number($decimal(20,4)) example: 10	The quantity received (as not damaged) for the item in this container.
quantityDamaged		number($decimal(20,4)) example: 5	The quantity received as damage for the item in this container.
caseSize		number($decimal(10,4)) example: 100	The case size of the item on this receipt.
purchaseOrderId		number($int12) example: 7444567333	The purchase order identifier if associated to a purchase order.
externalPurchaseOrderId		string($text128) example: 55001234	The external purchase order number if the purchase order originated from an external system.
customerOrderNumber		string($text128) example: 143523465425	The customer order number if associated to a customer order.
fulfillmentOrderNumber		string($text128) example: 134314	The fulfillment order number if associated to a customer order.
unitCostValue		number($decimal(12,4)) example: 11.5	The unit cost amount for this item on the receipt.
uins		object	A collection of uins on the item.

Table 6-14 UinExtIdo— Object

Element Name	Required	Required	Data Type/Example
uin	NA	string($text128) example: 20343932434	The universal identifier number.
status	NA	number($int2) example: 1	The status of the UIN. Valid values are: 1 - In Stock 2 - Sold 3 - Shipped To Warehouse 4 - Shipped To Store 5 - Reserved For Shipping 6 - Shipped To Vender 7 - Removed From Inventory 8 - Unavailable 9 - Missing 10 - In Receiving 11 - Customer Order Reserved 12 - Customer Order Fulfilled 13 - shipped To Finisher 99 - Unconfirmed Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 99 ]

Responses

This section describes the responses of the Receipt Confirmed API.

Response Code: 204

No content.

Integration of Direct From Vendor Return

When a vendor return is altered such as when it is approved or closed, or a vendor delivery receipt is made against the vendor return document, EICS will publish the updated vendor return to the service endpoint. The service must be configured on the external services administration screen.

REST Service: Vendor Return (External)

This service publishes out the information about a vendor return (RTV) to an external endpoint. This occurs when the vendor delivery receipt is confirmed.

Update Return

A notification of an updated return is sent when the vendor return is approved, closed, or otherwise modified.

Method

POST

URL

/vendorreturns

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the vendor return that was update.

Example Value

{
  "supplierId": 5510,
  "storeId": 5000,
  "receiptNumber": "A3DA",
  "invoiceNumber": "1004728342",
  "invoiceDate": "2025-02-11T14:42:26.122Z",
  "receiptDate": "2025-02-11T14:42:26.122Z",
  "deliveryType": 1,
  "originatingCountryCode": "CAN",
  "currencyCode": "CAD",
  "carrierCode": "SHP",
  "containers": [
    {
      "cartonId": 55001234,
      "externalCartonId": "234342",
      "trackingNumber": "863413410",
      "receiptDate": "2025-02-11T14:42:26.122Z",
      "adjusted": false,
      "missing": false,
      "items": [
        {
          "itemId": "55001234",
          "vendorProductNumber": "55001234",
          "quantityExpected": 10,
          "quantityReceived": 10,
          "quantityDamaged": 5,
          "caseSize": 100,
          "purchaseOrderId": 7444567333,
          "externalPurchaseOrderId": "55001234",
          "customerOrderNumber": "143523465425",
          "fulfillmentOrderNumber": "134314",
          "unitCostValue": 11.5,
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ]
        }
      ]
    }
  ]
}

Schema — VendorReturnExtIdo

Table 6-15 VendorReturnExtIdo — Object

Element Name	Required	Data Type/Example	Description
vendorReturnId	NA	number($int15) example: 222345666	The internal system identifier of the vendor return.
externalReturnId	NA	string($text128) example: 76544400	The external identifier of the vendor return from the originating system.
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the return.
supplierId	NA	number($int10) example: 5510	The identifier of the supplier receiving the return.
authorizationCode	NA	string($text12) example: A3DA	A vendor authorization code for the return.
supplierAddress1	NA	string($text240) example: Shipping Company	The first line of the supplier return address.
supplierAddress2	NA	string($text240) example: Suite 100	The second line of the supplier address.
supplierAddress3	NA	string($text240) example: Business Lane	The third line of the supplier return address.
supplierCity	NA	string($text129) example: Nowheresville	The city of the supplier return address.
supplierState	NA	string($text3) example: MN	The state of the supplier return address.
supplierCountry	NA	string($text3) example: USA	The country code of the supplier return address.
supplierPostalCode	NA	string($text30) example: 12345	The postal code of the supplier return address.
status	NA	number($int2) example: 1	The status of the return. Valid values are: 1 - Approved 2 - In Shipping 3 - Shipped 4 - Rejected 5 - Closed Enum: [ 1, 2, 3, 4, 5 ]
createDate	NA	string($date-time)	The date the vendor return was created.
approvedDate	NA	string($date-time)	The date the vendor return was approved.
lineItems	NA	object	A collection of line items on the vendor return.

Table 6-16 VendorReturnItemExtIdo — Object

Element Name	Required		Data Type/Example	Description
itemId	NA		string($text25) example: 55001234	The SKU level item identifier.
externalLineNumber	NA		number($int15) example: 2	The external line number.
quantityRequested	NA		number($decimal(20,4)) example: 10	The quantity originally requested.
quantityApproved	NA		number($decimal(20,4)) example: 10	The quantity approved.
quantityInShipping	NA		number($decimal(20,4)) example: 5	The quantity currently in picking/shipping.
quantityShipped	NA		number($decimal(20,4)) example: 5	The quantity shipped.
caseSize	NA		number($decimal(10,4)) example: 100	The case size of the item on this shipment.
unavailableInventory	NA		boolean example: false	True if this item is using unavailable inventory, false otherwise.
returnReason	NA		string($text5) example: O	The shipment return reason code.

Responses

This section describes the responses of the Update Return API.

Response Code: 204

No content.

Integration of Inventory Movements

EICS publishes out an inventory adjustment when the inventory positions change. This service must be configured on the external services administration screen.

REST Service: Inventory Adjustment (External)

This service publishes out the information about an inventory adjustment to an external endpoint.

Adjustments

Publishes out the information about adjustments.

Method

POST

URL

/adjustments

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the adjustment.

Example Value

{
  "storeId": 5000,
  "transactionType": 1,
  "transactionId": 9834135,
  "adjustments": [
    {
      "itemId": "55001234",
      "quantity": 10,
      "reasonCode": "182",
      "statusCodeFrom": "TRBL",
      "statusCodeTo": "ATS",
      "adjustmentUser": "smith123",
      "adjustmentDate": "2025-02-11T07:19:05.154Z",
      "uins": [
        {
          "uin": "20343932434",
          "status": 1
        }
      ]
    }
  ]
}

Schema — InvAdjustmentExtIdo

Table 6-17 InvAdjustmentExtIdo— Object

Element Name	Required	Data Type/Example	Description
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the goods.
transactionType	NA	number($int2) example: 1	The transaction type of a transaction associated to the adjustments. Valid values are: 1 - Auto Adjustment 2 - DSD Receiving 3 - Inventory Adjustmnet 4 - Point Of Sale 5 - RFID 6 - Stock Count Enum: [ 1, 2, 3, 4, 5, 6 ]
transactionId	NA	number($int15) example: 9834135	The transaction identifier of a transaction associated to (or responsible for the create of) the adjustments. This will only be present if the adjustments all derive from the same transaction.
adjustments	NA	object	A collection of adjustments

Table 6-18 InvAdjustmentItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantity	NA	number($decimal(20,4)) example: 10	The quantity of the adjustment.
reasonCode	NA	string($text4) example: 182	The reason code for the adjustment.
statusCodeFrom	NA	string($text4) example: TRBL	The inventory disposition status is moved from.
statusCodeTo	NA	string($text4) example: ATS	The inventory disposition status is moved to.
adjustmentUser	NA	string($text128) example: smith123	The user that confrimed the adjustment or transaction.
adjustmentDate	NA	string($date-time)	The date of the adjustment.
uins	NA	object	A collection of line items on the vendor return.

Table 6-19 UinExtIdo— Object

Element Name	Required	Required	Data Type/Example
uin	NA	string($text128) example: 20343932434	The universal identifier number.
status	NA	number($int2) example: 1	The status of the UIN. Valid values are: 1 - In Stock 2 - Sold 3 - Shipped To Warehouse 4 - Shipped To Store 5 - Reserved For Shipping 6 - Shipped To Vender 7 - Removed From Inventory 8 - Unavailable 9 - Missing 10 - In Receiving 11 - Customer Order Reserved 12 - Customer Order Fulfilled 13 - shipped To Finisher 99 - Unconfirmed Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 99 ]

Responses

This section describes the responses of the Adjustments API.

Response Code: 204

No content.

Integration with Manifesting Systems

In order for access to an external manifesting system to take place, the customer must first setup Carrier Type as "Third Party" and the Carrier Service (Manifest Type) must be Parcel (P). Configuration controls whether manifesting is done for a transfer to store, finisher, or warehouse. In addition, configuration controls manifesting for a return to vendor shipment or a customer order delivery.

Carrier services with manifest type of "O" (Other) and "H" (Home Fleet) do not go through the manifesting system. When Manifest Type is "O," EICS prompts the user to enter the carrier address where the shipment is to be sent for fulfillment. Manifest Type of "H" is within the company and therefore, does not prompt the user for an address.

Some carriers require weight, dimension, or both values to be sent in the manifest payload. If so, the carrier's service should have either the weight indicator or carton dimension indicate set to active (or both) during their carrier service setup.

EICS supplies an outbound and inbound Shipment Manifest SOAP web service. The following are supported service operations:

A web service is used to send all the shipment information to the external manifesting system and also to receive close shipment requests from external systems.

A web service accepts requests from external systems to close shipments. It is used to find those "Submitted" shipments for the provided tracking ID, carrier, service and date, and dispatch those shipments.

Note:

EICS supplies a WSDL and XSD that defines the web service, operation, and data content. This web service will need to be implemented either for the manifesting system or a plug-in set up.

SOAP Service: ShipmentManifestService

This web service notifies an external manifesting system that a manifest needs to be created.

Service Operation	Description
createManifest	Requests the external manifesting system to create a new parcel manifest for an input transaction.

SOAP Service: StoreShipmentManifestService

This web service receives a message from an external manifesting system that the items on the manifest have been picked up.

Service Operation	Description
closeManifest	Instructs EICS that submitted shipments have been picked up by the carrier.

REST Service: Manifest

This is a manifest service integration definition. This service must be implemented by an external system that wants to receive manifesting calls from EICS in order to manifest a shipment. EICS will send all the shipping information to this service and receive back basic tracking information for the shipment. In order for access to an external manifesting system to take place, the customer must first setup Carrier Type as "Third Party" and the Carrier Service (Manifest Type) must be Parcel (P). Configuration controls whether manifesting is done for a transfer to store, finisher, or warehouse. In addition, configuration controls manifesting for a return to vendor shipment or a customer order delivery. Carrier services with manifest type of "O" (Other) and "H" (Home Fleet) do not go through the manifesting system. When Manifest Type is "O," EICS prompts the user to enter the carrier address where the shipment is to be sent for fulfillment. Manifest Type of "H" is within the company and therefore, does not prompt the user for an address. Some carriers require weight, dimension, or both values to be sent in the manifest payload. If so, the carrier's service should have either the weight indicator or carton imension indicate set to active (or both) during their carrier service setup.

Obtain Shipment Manifest

Obtain shipment manifest information from the external system.

Method

POST

URL

/manifest

Request Parameters

There are no request parameters.

The request body is application/json.

Example Value

{
  "shipmentType": 1,
  "shipmentId": 11111,
  "storeId": 5000,
  "customerOrderId": "789012",
  "shippingCost": 54.23,
  "shippingCostCurrency": "USD",
  "carrierCode": "UPS",
  "carrierServiceCode": "2DAY",
  "packageHeight": 6,
  "packageWidth": 6,
  "packageLength": 6,
  "packUom": "CM",
  "packageWeight": 5.5,
  "packageWeightUom": "LBS",
  "deliveryDate": "2025-02-07T12:51:37.859Z",
  "printerUri": null,
  "userName": "smith123",
  "storeAddress": {
    "addressType": 1,
    "name": "Jane Smith",
    "address1": "7th Aveneue North",
    "address2": "Baker's Apartment Building",
    "address3": "Apartment 28A",
    "city": "Sunnyside",
    "county": "Vale",
    "stateCode": "WI",
    "countryCode": "USA",
    "postalCode": "55555"
  },
  "storeContact": {
    "firstName": "John",
    "lastName": "Smith",
    "fullName": "John Smith",
    "companyName": "Speedy, Inc.",
    "contactEmail": "[e-mail]",
    "contactFax": "A",
    "contactPhone": "[phone]",
    "contactPhoneType": 1
  },
  "destinationAddress": {
    "addressType": 1,
    "name": "Jane Smith",
    "address1": "7th Aveneue North",
    "address2": "Baker's Apartment Building",
    "address3": "Apartment 28A",
    "city": "Sunnyside",
    "county": "Vale",
    "stateCode": "WI",
    "countryCode": "USA",
    "postalCode": "55555"
  },
  "destinationContact": {
    "firstName": "John",
    "lastName": "Smith",
    "fullName": "John Smith",
    "companyName": "Speedy, Inc.",
    "contactEmail": "[e-mail]",
    "contactFax": "A",
    "contactPhone": "[phone]",
    "contactPhoneType": 1
  },
  "billingAddress": {
    "addressType": 1,
    "name": "Jane Smith",
    "address1": "7th Aveneue North",
    "address2": "Baker's Apartment Building",
    "address3": "Apartment 28A",
    "city": "Sunnyside",
    "county": "Vale",
    "stateCode": "WI",
    "countryCode": "USA",
    "postalCode": "55555"
  },
  "billingContact": {
    "firstName": "John",
    "lastName": "Smith",
    "fullName": "John Smith",
    "companyName": "Speedy, Inc.",
    "contactEmail": "[e-mail]",
    "contactFax": "A",
    "contactPhone": "[phone]",
    "contactPhoneType": 1
  },
  "items": [
    {
      "itemId": "100637445",
      "itemDescription": "Raspberry Tea",
      "quantity": "15.5",
      "unitOfMeasure": "KG"
    }
  ]
}

Schema — ManifestExtIdo

Table 6-20 ManifestExtIdo— Object

Element Name	Required	Data Type/Example	Description
shipmentType	NA	integer($int1) example: 1	The type of shipment. Valid values are: 1 - Fulfillment Order Delivery 2 - Transfer Shipment 3 - Return To Vendor Shipment Enum: [ 1, 2, 3
shipmentId	NA	number($int12) example: 11111	The unique identifier of the vendor shipment.
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the inventory.
customerOrderId	NA	string($text128) example: 789012	The customer order number.
shippingCost	NA	number($decimal(12,4)) example: 54.23	The amount of a delivery charge of the shipment.
shippingCostCurrency	NA	string($text3) example: USD	The currency code of the delivery charge.
carrierCode	NA	string($text4) example: UPS	The carrier code of the carrier being used.
carrierServiceCode	NA	string($text6) example: 2DAY	The carrier service code of the service being used.
packageHeight	NA	number($decimal(12,4)) example: 6	The height of the package in the package unit of measure.
packageWidth	NA	number($decimal(12,4)) example: 6	The width of the package in the package unit of measure.
packageLength	NA	number($decimal(12,4)) example: 6	The length of the package in the package unit of measure.
packUom	NA	string($text4) example: CM	The unit of measure of the package dimensions.
packageWeight	NA	number($decimal(12,4)) example: 5.5	The weight of the package in the weight unit of measure.
packageWeightUom	NA	string($text4) example: LBS	The unit of measure of the package weight.
deliveryDate	NA	string($date-time)	The delivery date of the shipment.
printerUri	NA	string($text300) example: null	The URI of the printer for a manifest.
userName	NA	string($text128) example: smith123	A user associated to the shipment.
storeAddress	NA	object	store address
storeContact	NA	object	store contact
destinationAddress	NA	object	destination address
destinationContact	NA	object	destination contact
billingAddress	NA	object	billing address
billingContact	NA	object	billing contact
items	NA	object	A collection of line items on the shipment.

Table 6-21 ManifestAddressExtIdo — Object

Element Name	Required	Data Type/Example	Description
addressType	NA	integer($int1) example: 1	The type of the address. Valid values are: 1 - Business 2 - Billing 3 - Delivery Enum: [ 1, 2, 3 ]
name	NA	string($text120) example: Jane Smith	The name of the contact at the address.
address1	NA	string($text240) example: 7th Avenue North	The first line of the address.
address2	NA	string($text240) example: Baker's Apartment Building	The second line of the address.
address3	NA	string($text240) example: Apartment 28A	The third line of the address.
city	NA	string($text120) example: Sunnyside	The city of the address.
county	NA	string($text250) example: Vale	The county of the address.
stateCode	NA	string($text3) example: WI	The state code of the address.
countryCode	NA	string($text3) example: USA	The country code of the address.
postalCode	NA	string($text30) example: 55555	The carrier code of the carrier being used. The postal code of the address.

Table 6-22 ManifestContactExtIdo — Object

Element Name	Required	Data Type/Example	Description
firstName	NA	string($text120) example: John	The first name of the contact.
lastName	NA	string($text120) example: Smith	The last name of the contact.
fullName	NA	string($text120) example: John Smith	The full name of the contact.
companyName	NA	string($text120) example: Speedy, Inc.	The company name.
contactEmail	NA	string($text100) example: [e-mail]	The email address of the contact.
contactFax	NA	string($text120) example: A	The fax number of the contact.
contactPhone	NA	string($text20) example: [phone]	The phone number of the contact.
contactPhoneType	NA	integer($int1) example: 1	The phone type of the phone number. Valid values are: 1 - Voice 2 - Work 3 - Fax Enum: [ 1, 2, 3 ]

Table 6-23 ManifestItemExtIdo — Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 100637445	The SKU number of the item.
itemDescription	NA	string($text400) example: Raspberry Tea	The description of the item.
quantity	NA	string($decimal(20,4)) example: 15.5	The quantity being shipped.
unitOfMeasure	NA	string($text4) example: KG	The unit of measure of the quantity being shipped.

Responses

This section describes the responses of the Obtain Shipment Manifest API.

Response Code: 200

The request has been successful.

The media type is application/json.

Example Value

[
  {
    "shipmentType": 1,
    "shipmentId": 11111,
    "carrierCode": "UPS",
    "carrierServiceCode": "2DAY",
    "carrierTrackingNumber": "AZB100245683"
  }
]

Schema — ManifestTrackExtIdo

Table 6-24 ManifestTrackExtIdo— Object

Element Name	Required	Data Type/Example	Description
shipmentType	NA	integer($int1) example: 1	The type of shipment. Valid values are: 1 - Fulfillment Order Delivery 2 - Transfer Shipment 3 - Return To Vendor Shipment Enum: [ 1, 2, 3 ]
shipmentId	Na	number($int15) example: 11111	The unique identifier of the shipment.
carrierCode	NA	string($text4) example: UPS	The carrier code of the carrier being used.
carrierServiceCode	NA	string($text6) example: 2DAY	The carrier service code of the service being used.
carrierTrackingNumber	NA	string($text128) example: AZB100245683	The tracking number provided by the carrier.

Integration for Notifications

Notifications that are generated by the system can be sent to an external system. The service must be configured on the external services administration screen.

SOAP Service: StoreExtNotificationService

SOAP service and operations for sending notifications to an external system.

Service Operation	Description
createNotification	Sends notification to external system.

REST Service: Notification (External)

This service publishes out the information about a notification (most often, an event that occurred in the system) to an external endpoint.

Notification

Publishes out the information about a notification.

Method

POST

URL

/notifications

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the notification.

Example Value

{
  "storeId": 5000,
  "name": "Late Delivery",
  "description": "Delivery 123 did not arrive by Tuesday 13th.",
  "createDate": "2025-02-10T11:46:26.867Z",
  "createUser": "System",
  "transactionType": 1,
  "transactionId": 9834135
}

Schema — NotificationExtIdo

Table 6-25 NotificationExtIdo— Object

Element Name	Required	Data Type/Example	Description
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the goods.
name	NA	string($text400) example: Late Delivery	The name, title, or summary text of the notification.
description	NA	string($text2000) example: Delivery 123 did not arrive by Tuesday 13th.	The contents of the notification.
createDate	NA	string($date-time)	The date the notification was created.
createUser	NA	string($text128) example: System	The user that created the notification.
transactionType	NA	number($int2) example:1	The transaction type of the transaction associated to the notification. Valid values are: 1 - Customer Order 2 - Customer Order Pick 3 - Customer Order Delivery 4 - Customer Order Reverse Pick 5 - Direct Store Delivery Receiving 6 - Invenotry Adjustment 7 - Item Basket 8 - Replenishment Gap 9 - Shelf Adjustment 10 - Shelf Replenishment 11 - Stock Count 12 - Store Order 13 - Transfer 14 - Transfer Shipment 15 - Transfer Receiving 16 - Vendor Return 17 - Vendor Return Shipment Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ]
transactionId	NA	number($int15) example: 9834135	The transaction identifier of a transaction associated to (or responsible for the create of) the notification.

Responses

This section describes the responses of the Notification API.

Response Code: 204

No content

Integration of Pre-Shipment Notification

A pre-shipment notification contains the same information as a final shipment but is sent in advance of the shipment when the user submits the shipment, if submit and pre-shipment are enabled and configured in the system. EICS publishes this pre-shipment notification to a service endpoint which must be configured on the external service administration screen.

REST Service: Pre-Shipment Notification (External)

This service publishes out the information about a shipment prior to its dispatch to an external endpoint.

Pre-Shipment Notice

Publishes out the information about a shipment.

Method

POST

URL

/

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the shipment.

Example Value

{
  "shipmentType": 1,
  "storeId": 5000,
  "destinationLocationType": 1,
  "destinationLocationId": "6100",
  "asn": "ABC123456",
  "billOfLadingNumber": "AX4234234",
  "addressLine1": "123 Orange Street",
  "addressLine2": "PO Box 1234",
  "addressLine3": "c/o Intake Processing",
  "addressCity": "Nowheresville",
  "addressState": "MN",
  "addressPostalCode": "12345",
  "addressCountryCode": "US",
  "carrierCode": "DF",
  "carrierServiceCode": "2Day",
  "notes": [
    "Rush transfer",
    "Promotional goods"
  ],
  "containers": [
    {
      "containerId": "550077733",
      "externalContainerId": 2,
      "containerWeight": 10,
      "containerWeightUom": 10,
      "trackingNumber": "FXD124A3434",
      "items": [
        {
          "itemId": "55001234",
          "quantity": 10,
          "documentId": "1234",
          "customerOrderNumber": "5666",
          "fulfillmentOrderNumber": "7888",
          "orderLineNumber": "9",
          "unavailable": "fakse",
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ]
        }
      ]
    }
  ]
}

Schema — PreShipmentExtIdo

Table 6-26 PreShipmentExtIdo - Object

Element Name	Required	Data Type/Example	Description
shipmentType	NA	number($int2) example: 1	The type of shipment. Valid values are: 1 - Fulfillment Order Delivery 2 - Transfer 3 - Vendor Return Enum: [ 1, 2, 3 ]
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the goods.
destinationLocationType	NA	number($int2) example: 1	The location type of the destination receiving the goods. Valid values are: 1 - Store 2 - Warehouse 3 - Finisher 4 - Supplier 5 - Customer Enum: [ 1, 2, 3, 4, 5 ]
destinationLocationId	NA	string($text128) example: 6100	The identifier of the destination location receiving the goods.
asn	NA	string($text128) example: ABC123456	The advanced shipment notification number.
billOfLadingNumber	NA	string($text128) example: AX4234234	The bill of lading number (or the ASN if no bill of lading exists).
addressLine1	NA	string($text240) example: 123 Orange Street	The first line of the address to ship to.
addressLine2	NA	string($text240) example: PO Box 1234	The second line of the address to ship to.
addressLine3	NA	string($text240) example: c/o Intake Processing	The third line of the address to ship to.
addressCity	NA	string($text120) example: Nowheresville	The city of the address to ship to.
addressState	NA	string($text3) example: MN	The state of the address to ship to.
addressPostalCode	NA	string($text30) example: 12345	The postal code of the address to ship to.
addressCountryCode	NA	string($text3) example: US	The country code of the address to ship to.
carrierCode	NA	string($text4) example: DF	The carrier code of the shipment carrier.
carrierServiceCode	NA	string($text6) example: 2Day	The carrier service code of the service being used.
notes	NA	string($text2000)] example: List [ "Rush transfer", "Promotional goods" ]	The notes associated to this shipment.
containers	NA	object	A collection of containers on the shipment.

Table 6-27 PreShipmentContainerExtIdo - Object

Element Name	Required	Data Type/Example	Description
containerId	NA	string($text128) example: 550077733	The container identifier.
externalContainerId	NA	number($int15) example: 2	An external container identifier (possibly capturing a container identifier of an originating system other than SIOCS).
containerWeight	NA	number($decimal(20,4)) example: 10	The weight of the container.
containerWeightUom	NA	number($decimal(20,4)) example: 10	The unit of measure of the weight of the container.
trackingNumber	NA	string($text128) example: FXD124A3434	The tracking number of the container.
items	NA	object	A collection of items within the container.

Table 6-28 PreShipmentItemExtIdo - Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantity	NA	number($decimal(20,4)) example: 10	The quantity being shipped.
documentId	NA	string($text5)example: 1234	The document number of the document associated to this transfer, such as a transfer, allocation, or purchase order.
customerOrderNumber	NA	string($text5)example: 5666	The identifier of the customer order associated to this line item.
fulfillmentOrderNumber	NA	string($text5)example: 7888	The identifier of the fulfillment order associated to this line item.
orderLineNumber	NA	string($text5)example: 9	A customer order line number associated to this line item.
unavailable	NA	boolean example: false	True if this item is using unavailable inventory, false otherwise.
uins	NA	object	A collection of line items on the vendor return.

Table 6-29 UinExtIdo - Object

Element Name	Required	Data Type/Example	Description
uin	NA	string($text128) example: 20343932434	The universal identifier number.
status	NA	number($int2) example: 1	The status of the UIN. Valid values are: 1 - In Stock 2 - Sold 3 - Shipped To Warehouse 4 - Shipped To Store 5 - Reserved For Shipping 6 - Shipped To Vender 7 - Removed From Inventory 8 - Unavailable 9 - Missing 10 - In Receiving 11 - Customer Order Reserved 12 - Customer Order Fulfilled 13 - shipped To Finisher 99 - Unconfirmed Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 99 ]

Responses

This section describes the responses of the Pre-Shipment Notification API.

Response Code: 204

No content

Integration for Sales Forecast

EICS can retrieves sales forecast information about items from an external third-party system. The service must be configured in the external services configuration administration screen.

SOAP Service: SalesForecastService

SOAP service that defines operations the external third-party system must implement.

Service Operation	Description
retrieveSalesForecast	Retrieves sales forecast data for the next 30 days for a particular item and store.

Integration of Shipments

EICS publishes out a shipment notification (ASN) to an external endpoint when the shipment is confirmed. The service must be configured on the external services administration screen.

REST Service: Shipment Notification (External)

This services is defined to send a notice of a shipment (ASN - Advance Shipment Notification). This indicates the shipment has taken place and the goods are on the way.

Shipment Notice

Publishes out the information about a shipment.

Method

POST

URL

/shipments

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the shipment.

Example Value

{
  "shipmentType": 1,
  "storeId": 5000,
  "destinationLocationType": 1,
  "destinationLocationId": "6100",
  "asn": "ABC123456",
  "billOfLadingNumber": "AX4234234",
  "dispatchDate": "2025-02-11T09:03:21.830Z",
  "addressLine1": "123 Orange Street",
  "addressLine2": "PO Box 1234",
  "addressLine3": "c/o Intake Processing",
  "addressCity": "Nowheresville",
  "addressState": "MN",
  "addressPostalCode": "12345",
  "addressCountryCode": "US",
  "carrierCode": "DF",
  "carrierServiceCode": "2Day",
  "notes": [
    "Rush transfer",
    "Promotional goods"
  ],
  "containers": [
    {
      "containerId": 550077733,
      "externalContainerId": "23483431",
      "containerWeight": 10,
      "containerWeightUom": "LB",
      "trackingNumber": "FXD124A3434",
      "items": [
        {
          "itemId": "55001234",
          "quantity": 10,
          "documentId": 138413,
          "customerOrderNumber": "934134",
          "fulfillmentOrderNumber": "43534134",
          "orderLineNumber": 1,
          "unavailable": "fakse",
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ]
        }
      ]
    }
  ]
}

Schema — ShipmentExtIdo

Table 6-30 ShipmentExtIdo— Object

Element Name	Required	Data Type/Example	Description
shipmentType	NA	number($int2) example: 1	The type of shipment. Valid values are: 1 - Fulfillment Order Delivery 2 - Transfer 3 - Vendor Return Enum: [ 1, 2, 3 ]
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the goods.
destinationLocationType	NA	number($int2) example: 1	The location type of the destination receiving the goods. Valid values are: 1 - Store 2 - Warehouse 3 - Finisher 4 - Supplier 5 - Customer Enum: [ 1, 2, 3, 4, 5 ]
destinationLocationId	NA	string($text128) example: 6100	The identifier of the destination location receiving the goods.
asn	NA	string($text128) example: ABC123456	The advanced shipment notification number.
billOfLadingNumber	NA	string($text128) example: AX4234234	The bill of lading number (or the ASN if no bill of lading exists).
dispatchDate	NA	string($date-time)	The date the shipment was dispatched.
addressLine1	NA	string($text240) example: 123 Orange Street	The first line of the address to ship to.
addressLine2	NA	string($text240) example: PO Box 1234	The second line of the address to ship to.
addressLine3	NA	string($text240) example: c/o Intake Processing	The third line of the address to ship to.
addressCity	NA	string($text120) example: Nowheresville	The city of the address to ship to.
addressState	NA	string($text3) example: MN	The state of the address to ship to.
addressPostalCode	NA	string($text30) example: 12345	The postal code of the address to ship to.
addressCountryCode	NA	string($text3) example: US	The country code of the address to ship to.
carrierCode	NA	string($text4) example: DF	The carrier code of the shipment carrier.
carrierServiceCode	NA	string($text6) example: 2Day	The carrier service code of the service being used.
notes	NA	string($text2000)] example: List [ "Rush transfer", "Promotional goods" ]	The notes associated to this shipment.
containers	NA	object	A collection of containers on the shipment.

Table 6-31 ShipmentContainerExtIdo— Object

Element Name	Required	Data Type/Example	Description
externalContainerId	NA	string($text128) example: 23483431	The identifier of the container if it originated in an external system.
containerWeight	NA	number($decimal(12,4)) example: 10	The weight of the container.
containerWeightUom	NA	string($text4) example: LB	The unit of measure of the weight of the container.
trackingNumber	NA	string($text128) example: FXD124A3434	The tracking number of the container.
items	NA	object	A collection of items within the container.

Table 6-32 ShipmentItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
quantity	NA	number($decimal(20,4)) example: 10	The quantity that was shipped.
documentId	NA	number($int15) example: 138413	The identifier of a document (transfer, PO) it is associated to.
customerOrderNumber	NA	string($text128) example: 934134	A customer order number of a customer order associated to the line item.
fulfillmentOrderNumber	NA	string($text128) example: 43534134	A fulfillment order number of a customer order fulfillment associated to the line item.
orderLineNumber	NA	number($int15) example: 1	The order line number of this item on the customer order.
unavailable	NA	boolean example: false	True if this item is using unavailable inventory, false otherwise.
uins	NA	object	A collection of UINs for this item.

Table 6-33 UinExtIdo— Object

Element Name	Required	Required	Data Type/Example
uin	NA	string($text128) example: 20343932434	The universal identifier number.
status	NA	number($int2) example: 1	The status of the UIN. Valid values are: 1 - In Stock 2 - Sold 3 - Shipped To Warehouse 4 - Shipped To Store 5 - Reserved For Shipping 6 - Shipped To Vender 7 - Removed From Inventory 8 - Unavailable 9 - Missing 10 - In Receiving 11 - Customer Order Reserved 12 - Customer Order Fulfilled 13 - shipped To Finisher 99 - Unconfirmed Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 99 ]

Responses

This section describes the responses of the Shipment Notice API.

Response Code: 204

No content.

Integration of Stock Count Schedules

With the product group schedule administration screen, you can create, update, and cancel a unit and amount stock count schedule. When you do so, EICS will publish information about that schedule to an external service endpoint if configured on the external service administration screen.

REST Service: Stock Count Schedule (External)

This service publishes out the information about a stock count schedule to an external endpoint. This occurs whenever the state of the schedule is altered.

Schedule Updated

This service will be accessed when the stock count schedule is updated.

Method

POST

URL

/countschedules

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the stock count schedule that was updated.

Example Value

{
  "scheduleId": 123343434,
  "description": "Monthly Count",
  "startDate": "2025-04-15T11:56:27.545Z",
  "allItems": false,
  "storeIds": [
    5000,
    5010
  ],
  "hierarchies": [
    {
      "departmentId": 1000,
      "classId": 2000,
      "subclassId": 3000
    }
  ]
}

Schema — StockCountScheduleExtIdo

Table 6-34 StockCountScheduleExtIdo - Object

Element Name	Required	Data Type/Example	Description
scheduleId	NA	number($int8) example: 123343434	The identifier of the stock count schedule.
description	NA	string($text250) example: Monthly Count	The description of the stock count schedule.
startDate	NA	string($date-time)	The date of the stock count.
allItems	NA	boolean example: false	True, if the schedule represents an all-item count, false if it represents a hierarchy count.
storeIds	NA	number($int10)] example: List [ 5000, 5010 ]	The store identifiers associated to the stock count schedule
hierarchies	NA	object	A collection of hierarchies the stock count is for.

Table 6-35 StockCountScheduleHierarchyExtIdo - Object

Element Name	Required	Data Type/Example	Description
departmentId	NA	number($int12) example: 1000	The department identifier.
classId	NA	number($int12) example: 2000	The class identifier.
subclassId	NA	number($int12) example: 3000	The subclass identifier.

Responses

This section describes the responses of the Schedule Updated API.

Response Code: 204

No content.

Schedule Canceled

This service will be accessed when the stock count schedule itself is cancelled.

Method

POST

URL

/delete/{scheduleId}

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the stock count schedule that was canceled.

Example Value

{
"scheduleId": 123343434, 
"description": "Monthly Count",
"startDate": "2025-04-15T11:56:27.545Z",
"allItems": false,
"storeIds": [
  5000,
  5010
],
"hierarchies": [
  {
    "departmentId": 1000, 
    "classId": 2000,
    "subclassId": 3000
   }
  ]
 }

Schema — StockCountScheduleCancelExtIdo

Table 6-36 StockCountScheduleCancelExtIdo - Object

Element Name	Required	Data Type/Example	Description
scheduleId	NA	number($int8) example: 123343434	The identifier of the stock count schedule.
description	NA	string($text250) example: Monthly Count	The description of the stock count schedule.
startDate	NA	string($date-time)	The date of the stock count.

Responses

This section describes the responses of the Schedule Canceled API.

Response Code: 204

No content.

Integration for Store Order

When either a store order is approved in EICS, or when a new store order is created by EICS (either manually or system generated), a notification to a third-party item management can be sent. The endpoint service must be configured in the external service configuration administration screen. EICS does not send newly created store order notification for store orders created by an external system.

SOAP Service: OrderApproveNotificationService

Service has operations for both approval and create notifications.

Service Operation	Description
orderRequestApproved	Sends notification to external item management system that the order request is approved.

StoreExtNotificationService

When store order with external ID is approved, EICS sends notification to the external system.

This service is applicable only for externally created store orders.

Service Operation	Description
createNotification	Sends notification to external system on approving the externally created store orders with its items information.

REST Service: Store Order (External)

Service has operations for both approval and create notifications.

Approve Order

A notification that a store order generated in an external system has been approved by the store.

Method

POST

URL

/storeorders/approvals

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the store order that was approved.

Example Value

{
  "orderId": 222345666,
  "storeId": 5000,
  "externalTransferId": "7000",
  "externalPurchaseOrderId": "8000",
  "requestedDeliveryDate": "2025-02-10T14:37:45.178Z",
  "approvedDate": "2025-02-10T14:37:45.178Z",
  "lineItems": [
    {
      "itemId": "55001234",
      "quantity": 5
    }
  ]
}

Schema — StoreOrderApproveExtIdo

Table 6-37 StoreOrderApproveExtIdo— Object

Element Name	Required	Data Type/Example	Description
orderId	NA	number($int15) example: 222345666	The internal system identifier of the store order.
storeId	NA	number($int10) example: 5000	The identifier of the store that will receive the goods.
externalTransferId	NA	string($text128) example: 7000	An external transfer identifier that this store order is associated to if it is a transfer approval (from a warehouse).
externalPurchaseOrderId	NA	string($text128) example: 8000	An external purchase order identifier that this store order is associated to if it is a purchase order approval (from a supplier).
requestedDeliveryDate	NA	string($date-time)	The date the goods should be delivered.
approvedDate	NA	string($date-time)	The date the store order was approved by the store.
lineItems	NA	object	A collection of line items on the store order.

Table 6-38 StoreOrderApproveItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantity	NA	number($decimal(20,4)) example: 5	The quantity approved.

Responses

This section describes the responses of the Approve Order API.

Response Code: 204

No content

Request Order

A notification of a request to generate a new order for goods.

Method

POST

URL

/storeorders/requests

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the store order that is being requested.

Example Value

  "orderId": 222345666,
  "storeId": 5000,
  "restrictSupplierId": 7000,
  "restrictWarehouseId": 4000,
  "restrictDepartmentId": 1000,
  "restrictClassId": 2000,
  "restrictSubclassId": 3000,
  "requestedDeliveryDate": "2025-02-10T15:26:28.424Z",
  "approvedDate": "2025-02-10T15:26:28.424Z",
  "lineItems": [
    {
      "itemId": "55001234",
      "quantity": 5,
      "caseSize": 2,
      "deliverySlotId": 5
    }
  ]
}

Schema — StoreOrderRequestExtIdo

Table 6-39 StoreOrderRequestItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
orderId	NA	number($int15) example: 222345666	The internal system identifier of the store order.
storeId	NA	number($int10) example: 5000	The identifier of the store that will receive the goods.
restrictSupplierId	NA	number($int12) example: 7000	Items requested should be restricted to this supplier.
restrictWarehouseId	NA	number($int12) example: 4000	Items requested should be restricted to this warehouse.
restrictDepartmentId	NA	number($int12) example: 1000	Items requested should be restricted to this department.
restrictClassId	NA	number($int12) example: 2000	Items requested should be restricted to this class.
restrictSubclassId	NA	number($int12) example: 3000	Items requested should be restricted to this subclass.
requestedDeliveryDate	NA	string($date-time)	The date the goods should be delivered.
approvedDate	NA	string($date-time)	The date the request for goods was approved by the store.
lineItems	NA	object	A collection of line items on the store order.

Table 6-40 StoreOrderRequestItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantity	NA	number($decimal(20,4)) example: 5	The quantity requested for delivery.
caseSize	NA	number($decimal(10,4)) example: 2	The case size requested for delivery.
deliverySlotId	NA	number($int15) example: 5	The identifier of the delivery time slot requested for the delivery of the item.

Responses

This section describes the responses of the Request Order API.

Response Code: 204

No content

Integration for Ticket Printing

When printing tickets, EICS sends ticket information to an external system for printing. This web service needs to be implemented for printing tickets to a physical printer. In the JET administration screen for configuration external service, this endpoint can be configured to connect to either a SOAP or a REST service implementation.

SOAP Ticket Printing

The details of the SOAP ticket printing endpoint is captured in the associated web service WSDL.

TicketPrintService

Service Operation	Description
printTickets	Sends item tickets to an external system to be printed. It must be implemented by the external system to receive the tickets.

REST Service: Ticket Printing

This web service defines an endpoint that can be developed by a third party in order to allow EICS to send item ticket printing information to an end system service that handles ticket printing.

The endpoint inputs and outputs must be adhered to by the provider.

API Publish Tickets

This API receives ticket printing information from EICS.

API Basics

Endpoint URL	{base URL}
Method	POST
Success Response	200 OK
Input	Input Print Request For Store and Printer
Output	None

Input Data Definition (Ticket Print Request)

Payload	Type	Definition
storeId	Long(10)	The identifier of the store.
printerName	String(200)	The name of the printer.
printerAddress	String(300)	The URI (or network address) of the printer.
printerId	String(5)	The identifier of the printer.
formatType	Integer(4)	The type of ticket format to print. See Index
formatReference	String(255)	A reference to the format content to use.
templateId	Long(12)	The identifier of a template to use to print the tickets.
tickets	List<Tickets>	A collection of tickets to print.

Tickets

Payload	Type	Definition
ticketId	Long(12)	The identifier of the ticket.
itemId	String(25)	The identifier of the item/sku.
primaryUpc	Strin(25)	The primary Unique Produce Code for the item.
originType	Integer	The origin of the ticket.
sequenceNumber	Integer(3)	The sequence number of the ticket within its grouping.
ticketCount	Integer(3)	The number of instances of this ticket to print.
printQuantity	BigDecimal(12,4)	The quantity to be printed on each ticket.
shortDescription	String(255)	A short description for the item.
longDescription	String(400)	A long description for the item.
shortDescriptionLang	String(255)	A short descripton for the item at the store.
longDescriptionLang	String(400)	A long descripton for the item at the store.
diffType1	String(255)	The description of the first differentiator type.
diffType2	String(255)	The description of the second differentiator type.
diffType3	String(255)	The description of the third differentiator type.
diffType4	String(255)	The description of the fourth differentiator type.
diffDescription1	String(255)	The description of the first differentiator.
diffDescription2	String(255)	The description of the second differentiator.
diffDescription3	String(255)	The description of the third differentiator.
diffDescription4	String(255)	The description of the fourth differentiator.
departmentId	Long(12)	The department identifier of the item.
departmentName	String(360)	The department name.
classId	Long(12)	The class identifier of the item.
className	String(360)	The class name.
subclassId	Long(12)	The subclass identifier of the item.
subclassName	String(360)	The subclass name.
priceCurrency	String(3)	The currency code of the ticket price.
priceValue	BigDecimal(12,4)	The value of the ticket price.
priceType	Integer(3)	The type of the ticket price. See Index.
priceUom	String(4)	The unit of measure of the ticket price.
priceActiveDate	Date	The date the ticket price became active.
priceExpireDate	Date	The date the ticket price expired.
overridePriceCurrency	String(3)	An override price currency code.
overridePriceValue	BigDecimal(20,4)	The amount of an override price.
previousPriceCurrency	String(3)	A previous price currency code.
previousPriceValue	BigDecimal(20,4)	The amount of a previous price.
previousPriceType	Integer(3)	The price type of the previous price. See Index.
lowestMonthlyPriceCurrency	String(3)	The currency code of the lowest monthly price.
lowestMontlyPriceValue	BigDecimal(20,4)	The amount of the lowest monthly price.
lowestMonthlyPriceType	Integer(3)	The price type of the lowest montly price. See Index.
multiUnitPriceCurrency	String(3)	The currency code of the multi-unit price.
multiUnitValue	BigDecimal(20,4)	The amount of the multi-unit price.
multiUnitUom	String(4)	The unit of measure of the multi-unit price.
multiUnitQuantity	BigDecimal(12,4)	The multi-unit quantity associated to the price.
countryOfManufacture	String(3)	The country code of the country of manufacture of the item.
udas	List<TicketUdaExtIdo>	A list of user defined attributes associated to the ticket.

TicketUdaExtIdo

Payload	Type	Definition
name	String(120)	The name of the user defined attribute.
value	String(250)	The value of the user defined attribute.

Additional Data Definitions

Table Format Type

ID	Origin
1	Item Ticket
2	Shelf Label

Ticket Price Type

ID	Origin
1	Permanent
2	Promotional
3	Clearance
4	Clearance Reset

Ticket Origin Type

ID	Origin
1	External
2	Price Change
3	Foundation
4	Manual
5	Promotional Price Change
6	Clearance Price Change
7	Permanent Price Change

Integration of Transfers

When changes occur to transfer documents, EICS publishes the updated transfer to an external service. This occurs when the transfer stock quantities are altered or the transfer status changes. The service must be configured on the external services administration screen.

REST Service: Transfer Status (External)

This service publishes out the information about changes to a transfer document to an external endpoint. This occurs when the transfer stock quantities are altered or the transfer status changes.

Status Update

When the transfer status or quantities are altered, this operation is called to notify an external system of the state of the transfer.

Method

POST

URL

/tsfstatus

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer that was altered.

Example Value

{
  "transferId": 3413412,
  "externalTransferId": "3464435",
  "distroNumber": "3464435",
  "sourceType": 1,
  "sourceId": 5000,
  "destinationType": 1,
  "destinationId": 5100,
  "status": 1,
  "contextCode": "BAC",
  "contextValue": "Temporary Remodel",
  "unavailable": false,
  "customerOrderNumber": "83233434",
  "fulfillmentOrderNumber": "CAD",
  "requestDate": "2025-02-11T13:00:29.658Z",
  "approveDate": "2025-02-11T13:00:29.658Z",
  "items": [
    {
      "itemId": "55001234",
      "quantityRequested": 10,
      "quantityApproved": 10,
      "quantityShipping": 5,
      "quantityShipped": 5,
      "caseSize": 100
    }
  ]
}

Schema — TransferExtIdo

Table 6-41 TransferExtIdo — Object

Element Name	Required	Data Type/Example	Description
transferId	NA	number($int15) example: 3413412	The identifier of the transfer.
externalTransferId	NA	string($text128) example: 3464435	The external identifier of the transfer if it originated in an external system.
distroNumber	NA	string($text128) example: 3464435	The distro number of the transfer.
sourceType	NA	number($int2) example: 1	The location type of the source location shipping the goods. Valid values are: 1 - Store 2 - Warehouse 3 - Finisher Enum: [ 1, 2, 3 ]
sourceId	NA	number($int10) example: 5000	The identifier of the location shipping the goods.
destinationType	NA	number($int2) example: 1	The location type of the destination location receiving the goods. Valid values are: 1 - Store 2 - Warehouse 3 - Finisher Enum: [ 1, 2, 3 ]
destinationId	NA	number($int10) example: 5100	The identifier of the location receiving the goods.
status	NA	number($int2) example: 1	The current status of the transfer. Valid values are: 1 - New Request 2 - Requested 3 - Request In Progress 4 - Rejected 5 - Canceled Request 6 - Transfer In Progress 7 - Approved 8 - In Shipping 9 - Completed 10 - Cancelled Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
contextCode	NA	string($text6) example: BAC	The context code of a context associated to the transfer.
contextValue	NA	string($text25) example: Temporary Remodel	A value associated with the context.
unavailable	NA	boolean example: false	True indicates a transfer for unavailable quantities, false indicates that transfer is for available quantities.
customerOrderNumber	NA	string($text128) example: 83233434	The customer order number of a customer order associated to the transfer.
fulfillmentOrderNumber	NA	string($text128) example: CAD	The fulfillment order number of a customer order associated to the transfer.
requestDate	NA	string($date-time)	The date when the transfer was requested.
approveDate	NA	string($date-time)	The date the transfer was approved.
items		object	A collection of line items within the container.

Table 6-42 TransferItemExtIdo — Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantityRequested	NA	number($decimal(20,4)) example: 10	The quantity that has been requested.
quantityApproved	NA	number($decimal(20,4)) example: 10	The quantity that has been approved.
quantityShipping	NA	number($decimal(20,4)) example: 5	The quantity picked and in shipping.
quantityShipped	NA	number($decimal(20,4)) example: 5	The quantity that has been shipped.
caseSize	NA	number($decimal(10,4)) example: 100	The case size of the item on this transfer.

Responses

This section describes the responses of the Status Update API.

Response Code: 204

No content.

Integration of Transfer Receipts

EICS publishes out a vendor delivery receipt (DCS receipt) to an external endpoint when the delivery is confirmed. The service must be configured on the external services administration screen.

REST Service: Transfer Delivery Receipt (External)

This service publishes out the information about a transfer delivery receipt to an external endpoint. This occurs when the transfer delivery receipt is confirmed.

Receipt Confirmed

When the transfer delivery receipt is confirmed, this information about the receipt is sent.

Method

POST

URL

/tsfreceipts

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer delivery receipt that was confirmed.

Example Value

{
  "storeId": 5000,
  "sourceType": 2,
  "sourceId": 7100,
  "receiptNumber": "A3DA",
  "containers": [
    {
      "cartonId": 55001234,
      "externalCartonId": "234342",
      "referenceCartonId": "6764747",
      "trackingNumber": "863413410",
      "receiptDate": "2025-02-11T11:51:15.169Z",
      "adjusted": false,
      "missing": false,
      "items": [
        {
          "itemId": "55001234",
          "quantityExpected": 10,
          "quantityReceived": 10,
          "quantityDamaged": 5,
          "caseSize": 100,
          "unavailable": true,
          "documentType": 2,
          "documentId": 55001234,
          "customerOrderNumber": "143523465425",
          "fulfillmentOrderNumber": "134314",
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ]
        }
      ]
    }
  ]
}

Schema — TransferReceiptExtIdo

Table 6-43 TransferReceiptExtIdo — Object

Element Name	Required	Data Type/Example	Description
storeId	NA	number($int10) example: 5000	The identifier of the store receiving the goods.
sourceType	NA	number($int2) example: 2	The type of delivery. Valid values are: 1 - ASN 2 - PO 3 - DEX-NEX 4 - Manual Enum: [ 1, 2, 3, 4 ]
sourceId	NA	number($int10) example: 7100	The location identifier of the location shipping the goods.
receiptNumber	NA	number($int12) example: A3DA	The receipt number of the delivery.
containers	NA	object	A collection of containers on the delivery.

Table 6-44 TransferReceiptContainerExtIdo — Object

Element Name	Required	Data Type/Example	Description
cartonId	NA	number($int12) example: 55001234	The system internal container identifier.
externalCartonId	NA	string($text128) example: 234342	An external system carton identifier for reference.
referenceCartonId	NA	string($text128) example: 6764747	A reference identifier to an alternate container, such as a misdirected container.
trackingNumber	NA	string($text128) example: 863413410	The tracking number of the container.
receiptDate	NA	string($date-time)	The date the container was received.
adjusted	NA	boolean example: false	True if the carton is adjusted from a previous receipt, false if the container is first receipt.
missing	NA	boolean example: false	True if the carton is missing from the receipt, false if it is received.
items	NA	object	A collection of line items within the container.

Table 6-45 TransferReceiptItemExtIdo — Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantityExpected	NA	number($decimal(20,4)) example: 10	The quantity originally expected to be received.
quantityReceived	NA	number($decimal(20,4)) example: 10	The quantity received (as not damaged) for the item in this container.
quantityDamaged	NA	number($decimal(20,4)) example: 5	The quantity received as damage for the item in this container.
caseSize	NA	number($decimal(10,4)) example: 100	The case size of the item on this receipt.
unavailable	NA	boolean example: true	True if the quantities were received as unavailable, false if they were received as available. Note that even if this value is true, damaged quantities will still be received as unavailable.
documentType	NA	number($int2) example: 2	The type of document this item is associated to. Valid values are: 1 - Allocation 2 - Transfer Enum: [ 1, 2
documentId	NA	number($int15) example: 55001234	The identifier of the document associated to this item on the delivery.
customerOrderNumber	NA	string($text128) example: 143523465425	The customer order number if associated to a customer order.
fulfillmentOrderNumber	NA	string($text128) example: 134314	The fulfillment order number if associated to a customer order.
unis	NA	object	A collection of uins within the item.

Table 6-46 UinExtIdo— Object

Element Name	Required	Required	Data Type/Example
uin	NA	string($text128) example: 20343932434	The universal identifier number.
status	NA	number($int2) example: 1	The status of the UIN. Valid values are: 1 - In Stock 2 - Sold 3 - Shipped To Warehouse 4 - Shipped To Store 5 - Reserved For Shipping 6 - Shipped To Vender 7 - Removed From Inventory 8 - Unavailable 9 - Missing 10 - In Receiving 11 - Customer Order Reserved 12 - Customer Order Fulfilled 13 - shipped To Finisher 99 - Unconfirmed Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 99 ]

Responses

This section describes the responses of the Receipt Confirmed API.

Response Code: 204

No content.

Integration of Order Available Stock On Hand

REST Service: Customer Order Store Available Inventory (External)

This service sends changes to the available inventory of items for stores that have been marked as customer order allowable stores. In addition, a system flag for publishing customer order store available inventory must be selected.

Available Inventory Update

The current available inventory positions are sent to this service whenever the item available inventory changes for an item at the store.

Method

POST

URL

/

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the location and items and their current available quantities.

Example Value

{
  "storeId": 5000,
  "items": [
    {
      "itemId": "76544400",
      "availableQuantity": 10
    }
  ]
}

Schema — CoAvailableInventoryIdo

Table 6-47 CoAvailableInventoryIdo — Object

Element Name	Required	Data Type/Example	Description
storeId	NA	number($int10) example: 5000	The identifier of the store receiving the goods.
items	NA	object	Items

Table 6-48 CoAvailableInventoryItemIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 76544400	The identifier of the item being updated.
availableQuantity	NA	number($decimal(20,4)) example: 10	The available quantity of the item at this store.

Responses

This section describes the responses of the Receipt Confirmed API.

Response Code: 204

No content.