Acknowledge Shipment

Acknowledges the tracking is created.

POST /shipment/acknowledge

Try it

Acknowledge Shipment

cURL

curl --request POST \
  --url https://prod01.oms.fabric.inc/api/v2/shipment/acknowledge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shipmentId": "78974156816152",
  "attributes": {}
}
'

200

{
  "shipmentId": "627963716b19511e8a3a631b",
  "shipmentNum": "78974156816152",
  "invoiceId": "5674156816152",
  "allocationId": "112345678912340",
  "orderNumber": [
    "112345678912340",
    "112345678912340"
  ],
  "poNumber": "1125",
  "vendorId": "56",
  "statusCode": "SHIPPED",
  "type": "STANDARD",
  "reshipmentReasonCode": "Order went missing",
  "shipDate": "2022-06-06T07:58:30.996Z",
  "locationNum": "132412",
  "locationType": "DC",
  "totalCartons": 2,
  "masterTrackingNumber": "TX112345678",
  "shipToId": "1",
  "shipToAddress": {
    "addressLine1": "888 Broadway",
    "addressLine2": "505 suite",
    "addressLine3": "<string>",
    "addressLine4": "<string>",
    "city": "New York",
    "state": "NY",
    "country": "USA",
    "postalCode": "1003",
    "type": "home",
    "latitude": 134.13413,
    "longitude": 757.0435
  },
  "recipient": [
    {
      "name": {
        "first": "John",
        "middle": "<string>",
        "last": "Doe"
      },
      "email": "[e-mail]",
      "phone": {
        "number": 10612345678,
        "type": "MOBILE"
      }
    }
  ],
  "cartons": [
    {
      "cartonNum": "1",
      "cartonType": "Package",
      "promisedDeliveryDate": "2022-05-26T07:58:30.996Z",
      "estimatedShipDate": "2022-05-25T07:58:30.996Z",
      "estimatedDeliveryDate": "2022-05-26T07:58:30.996Z",
      "shipmentMethod": "ground",
      "shipmentCarrier": "FEDEX",
      "weight": "500 gram",
      "trackingNumber": "1Z999AA10123456784",
      "trackingURL": "https://fedex.com/tracking",
      "trackingDetails": [
        {
          "event": "picked up",
          "eventId": "627963716b19511e8a3a631b",
          "timestamp": "2019-09-30T07:58:30.996Z",
          "shipmentCarrier": "FEDEX",
          "location": "Reno, NV",
          "notes": {}
        }
      ],
      "items": [
        {
          "shipmentLineItemId": "607f1f77bcf86cd799439011",
          "orderId": "317736896",
          "orderNumber": "507f1f77bcf86cd799439011",
          "lineItemId": "1",
          "itemId": "100023",
          "sku": "SKU0023",
          "channelId": "12",
          "segment": null,
          "vendorId": "56",
          "orderedQuantity": 2,
          "shippedQuantity": 2,
          "returnQuantity": 1,
          "returnAmount": 10,
          "fees": [
            {
              "type": "tax",
              "value": 34.56,
              "quantity": 12,
              "refundAmount": 10.4
            }
          ],
          "giftCard": [
            {
              "giftCardNum": "453456765",
              "amount": 50,
              "giftCardStatus": "ACTIVE",
              "giftCardActiveRequestDate": "2022-05-26T07:58:30.996Z",
              "giftCardActiveDate": "2022-06-26T07:58:30.996Z"
            }
          ],
          "attributes": {},
          "uom": null
        }
      ]
    }
  ],
  "scratchedItems": [
    {
      "orderId": "507f1f77bcf86cd799439012",
      "lineItemId": "2",
      "itemId": "100043",
      "sku": "SKU00043",
      "quantity": 1,
      "reasonCode": "<string>",
      "subReasonCode": "<string>",
      "attributes": {},
      "uom": null
    }
  ],
  "createdAt": "2022-06-06T07:58:30.996Z",
  "updatedAt": "2022-06-06T07:58:30.996Z",
  "auditLogs": [
    {
      "auditType": "create",
      "employeeId": "62272e917b12209e68751d94",
      "auditTimestamp": "2022-05-12T09:24:54.804Z",
      "source": "POS",
      "note": "Note",
      "attributes": {},
      "updatedFields": [
        {
          "attributeName": "UOM",
          "attributeOriginalValue": "PK"
        }
      ]
    }
  ],
  "attributes": {}
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Details of shipment acknowledgement

shipmentId · string

Shipment ID

Example:

"78974156816152"

attributes · object

Response

200

application/json

Ok

Shipment details

shipmentId · string

24-character fabric-generated unique ID of shipment

Example:

"627963716b19511e8a3a631b"

shipmentNum · string

Shipment number (external)

Example:

"78974156816152"

invoiceId · string

fabric-generated Invoice ID

Example:

"5674156816152"

allocationId · string

Allocation ID for an order, generated from allocation service

Example:

"112345678912340"

orderNumber · string[]

Order number. It's usually generated by another system, such as an external checkout system.

Example:

["112345678912340", "112345678912340"]

poNumber · string

Purchase order number (generally, vendor-generated)

Example:

"1125"

vendorId · string

Vendor ID

Example:

"56"

statusCode · enum<string>

Shipment status code

Available options: SHIPMENT_CREATED, SHIPMENT_CANCELLED, PICKUP_CREATED, PICKUP_COMPLETED, SHIPMENT_RETURN_PENDING, SHIPMENT_RETURN_RECEIVED, SHIPMENT_PARTIALLY_DELIVERED, SHIPMENT_DELIVERED

Example:

"SHIPPED"

type · enum<string>

shipment type

Available options: STANDARD, RESHIP, RETURN, SCRATCH, PICKUP

Example:

"STANDARD"

reshipmentReasonCode · string

Reason code for reshipment

Example:

"Order went missing"

shipDate · string<date-time>

Time of shipping

Example:

"2022-06-06T07:58:30.996Z"

locationNum · string

location number from location service to get exact address.

Example:

"132412"

locationType · string

Location type based on location service such as store, distribution center (DC)

Example:

"DC"

totalCartons · integer<int32>

Total number of cartons

Example:

2

masterTrackingNumber · string

Main tracking number, to track fulfillment of all the orders

Example:

"TX112345678"

shipToId · string

Ship-to ID refers to item's delivery address

Example:

"1"

shipToAddress · object

Details of delivery address

Show child attributes

shipToAddress. addressLine1 · string

Line 1 of address

Example:

"888 Broadway"

shipToAddress. addressLine2 · string

Line 2 of address

Example:

"505 suite"

shipToAddress. addressLine3 · string

Line 3 of address

shipToAddress. addressLine4 · string

Line 3 of address

shipToAddress. city · string

City of delivery

Example:

"New York"

shipToAddress. state · string

State of delivery

Example:

"NY"

shipToAddress. country · string

Country name

Example:

"USA"

shipToAddress. postalCode · string

Postal code

Example:

"1003"

shipToAddress. type · string

Address type

Example:

"home"

shipToAddress. latitude · number<double>

Geo-latitude of delivery address

Example:

134.13413

shipToAddress. longitude · number<double>

Geo-longitude of delivery address

Example:

757.0435

recipient · object[]

Show child attributes

recipient. name · object

Primary contact details

Show child attributes

recipient.name. first · string

First name of primary contact

Example:

"John"

recipient.name. middle · string

Middle name of primary contact

recipient.name. last · string

Last name of primary contact

Example:

"Doe"

recipient. email · string

Email address of primary contact for delivery

Example:

"[e-mail]"

recipient. phone · object

Phone number of primary contact

Show child attributes

recipient.phone. number · string

Phone number of primary contact

Example:

10612345678

recipient.phone. type · string

Phone type of primary contact

Example:

"MOBILE"

cartons · object[]

Show child attributes

cartons. cartonNum · string

Carton number to identify packages

Example:

"1"

cartons. cartonType · string

Cartoon type

Example:

"Package"

cartons. promisedDeliveryDate · string<date-time>

Promised delivery date

Example:

"2022-05-26T07:58:30.996Z"

cartons. estimatedShipDate · string<date-time>

Estimated shipping date

Example:

"2022-05-25T07:58:30.996Z"

cartons. estimatedDeliveryDate · string<date-time>

Estimated delivery date

Example:

"2022-05-26T07:58:30.996Z"

cartons. shipmentMethod · string

Shipment method

Example:

"ground"

cartons. shipmentCarrier · string

Shipment carrier

Example:

"FEDEX"

cartons. weight · string

Shipment weight

Example:

"500 gram"

cartons. trackingNumber · string

Courier tracking number for the carton

Example:

"1Z999AA10123456784"

cartons. trackingURL · string

Shipment tracking URL

Example:

"https://fedex.com/tracking"

cartons. trackingDetails · object[]

Shipment tracking details

Show child attributes

cartons.trackingDetails. event · string

Event status

Example:

"picked up"

cartons.trackingDetails. eventId · string

24-character system-generated unique event ID

Example:

"627963716b19511e8a3a631b"

cartons.trackingDetails. timestamp · string

Time of event creation

Example:

"2019-09-30T07:58:30.996Z"

cartons.trackingDetails. shipmentCarrier · string

Shipment carrier name. Applicable in case of a different carrier

Example:

"FEDEX"

cartons.trackingDetails. location · string

Current location

Example:

"Reno, NV"

cartons.trackingDetails. notes · object

shipment notes

Show child attributes

cartons.trackingDetails.notes. {key} · string

Shipment notes, for reference

cartons. items · object[]

Item details

Show child attributes

cartons.items. shipmentLineItemId · string

Line item ID of shipment

Example:

"607f1f77bcf86cd799439011"

cartons.items. orderId · string

Order ID (fabric-generated)

Example:

"317736896"

cartons.items. orderNumber · string

Order number. It's usually generated by another system, such as an external checkout system.

Example:

"507f1f77bcf86cd799439011"

cartons.items. lineItemId · string

Line item ID to identify item in the order

Example:

"1"

cartons.items. itemId · string

Item ID

Example:

"100023"

cartons.items. sku · string

SKU of item

Example:

"SKU0023"

cartons.items. channelId · string

Sales channel ID

Example:

"12"

cartons.items. segment · string

Segment associated with item

Example:

null

cartons.items. vendorId · string

Vendor ID

Example:

"56"

cartons.items. orderedQuantity · integer<int32>

Items ordered. Currently, there is no validation in place

Example:

2

cartons.items. shippedQuantity · integer<int32>

Items shipped

Example:

2

cartons.items. returnQuantity · integer<int32>

Items returned

Example:

1

cartons.items. returnAmount · number

Return amount

Example:

10

cartons.items. fees · object[]

Show child attributes

cartons.items.fees. type · string

Component of shipment fee

Example:

"tax"

cartons.items.fees. value · number

Value corresponding to type

Example:

34.56

cartons.items.fees. quantity · integer<int32>

Shipment quantity

Example:

12

cartons.items.fees. refundAmount · number

Refund amount

Example:

10.4

cartons.items. giftCard · object[]

Show child attributes

cartons.items.giftCard. giftCardNum · string

Gift card number

Example:

"453456765"

cartons.items.giftCard. amount · number

Gift card amount

Example:

50

cartons.items.giftCard. giftCardStatus · string

Gift card status

Example:

"ACTIVE"

cartons.items.giftCard. giftCardActiveRequestDate · string

Time of placing gift card activation request

Example:

"2022-05-26T07:58:30.996Z"

cartons.items.giftCard. giftCardActiveDate · string

Time of gift card activation

Example:

"2022-06-26T07:58:30.996Z"

cartons.items. attributes · object

Show child attributes

cartons.items.attributes. {key} · object

cartons.items. uom · string

Unit of measure

Example:

null

scratchedItems · object[]

details of scratched items

Show child attributes

scratchedItems. orderId · string

Order ID (fabric-generated)

Example:

"507f1f77bcf86cd799439012"

scratchedItems. lineItemId · string

Line item ID to identify item in the order

Example:

"2"

scratchedItems. itemId · string

Item ID

Example:

"100043"

scratchedItems. sku · string

SKU number

Example:

"SKU00043"

scratchedItems. quantity · integer<int32>

Item quantity

Example:

1

scratchedItems. reasonCode · string

Reason code for return

scratchedItems. subReasonCode · string

sub-reason code for return

scratchedItems. attributes · object

Additional details of scratched item

Show child attributes

scratchedItems.attributes. {key} · object

scratchedItems. uom · string

Unit of measure

Example:

null

createdAt · string<date-time>

Time of shipment creation

Example:

"2022-06-06T07:58:30.996Z"

updatedAt · string<date-time>

Time of last update

Example:

"2022-06-06T07:58:30.996Z"

auditLogs · object[]

Details of audit logs

Show child attributes

auditLogs. auditType · string

Audit type

Example:

"create"

auditLogs. employeeId · string

Employee ID (store context)

Example:

"62272e917b12209e68751d94"

auditLogs. auditTimestamp · string

Time of audit

Example:

"2022-05-12T09:24:54.804Z"

auditLogs. source · string

Source of audit

Example:

"POS"

auditLogs. note · string

Notes related audit, for future reference

Example:

"Note"

auditLogs. attributes · object

Show child attributes

auditLogs.attributes. {key} · object

auditLogs. updatedFields · object[]

Show child attributes

auditLogs.updatedFields. attributeName · string

Attribute name

Example:

"UOM"

auditLogs.updatedFields. attributeOriginalValue · string

Original value of attribute, to track change in values for the given attributeName

Example:

"PK"

attributes · object

Attribute details for additional information

Show child attributes

attributes. {key} · object

Details of additional attributes, if applicable