Fulfillment Detail API

Endpoint

GET /fulfillment/{fulfillment_id}

Headers

Key	Value
Authorization	Bearer change_to_your_access_token
X-S2-Organization	your_organization_id

Path Parameters

Parameter	Type	Required	Description
fulfillment_id	string	Yes	The unique identifier of the fulfillment order

Response Body

Field	Type	Description
id	string	The unique identifier of the fulfillment order
status	string	Current status of the fulfillment (e.g., "CREATED", "PENDING", etc.)
address	Address Object	Shipping address details. See Address Object for details
channelFulfillmentId	string	External channel's fulfillment identifier
meta	object	Additional metadata associated with the fulfillment
warehouse	Warehouse Object	Details about the warehouse. See Warehouse Object for details
warehousePickId	string	Identifier for the warehouse pick
warehousePickStatus	string	Status of the warehouse pick (e.g., "PENDING")
shippingMethod	string	The shipping method being used
signatureRequired	boolean	Whether signature is required for delivery
items	array	List of items in the fulfillment. See Fulfillment Item Object for details
notes	array	List of notes associated with the fulfillment
attachments	array	List of attachments. See Attachments Object for details
shipments	array	List of shipments. See Shipment Object for details
shippingQuotes	array	List of shipping quotes
orderOrganization	Organization Object	Organization details. See Organization Object for details
shipByDate	string	The date by which the order should be shipped (ISO 8601 format)
deliverByDate	string	The date by which the order should be delivered (ISO 8601 format)
customerNote	string	Notes from the customer
referenceIds	array	List of reference identifiers
orderId	string	The associated order identifier
rmaId	string	The associated RMA identifier
orderDate	string	The date when the order was placed (ISO 8601 format)
orderAccountId	string	The account identifier associated with the order
orderChannelOrderId	string	The channel's order identifier
orderType	string	Type of order (e.g., "B2C")
method	string	Fulfillment method (e.g., "SPD")

Address Object

Field	Type	Description
type	string	Type of address (e.g., "UNSPECIFIED")
name	string	The full name of the recipient
company	string	The company name
address1	string	Primary street address
address2	string	Additional address information (e.g., apartment, suite, unit, etc.)
address3	string	Additional address information
city	string	City name
state	string	State or province
postalCode	string	Postal or ZIP code
countryId	string	Country code in ISO 3166-1 alpha-2 format
phone	string	Contact phone number
email	string	Contact email address

Warehouse Object

Field	Type	Description
id	string	Unique identifier of the warehouse
organization	Organization Object	Organization details
name	string	Name of the warehouse
address	Address Object	Physical address of the warehouse
dropshipper	boolean	Whether the warehouse is a dropshipper
fulfillmentCenter	boolean	Whether the warehouse is a fulfillment center
rmaCenter	boolean	Whether the warehouse is an RMA center
unitSystem	string	Unit system used (e.g., "METRIC")
endOfDayTime	string	End of day cutoff time
timezone	string	Timezone of the warehouse
wmsDisabled	boolean	Whether WMS is disabled for this warehouse

Organization Object

Field	Type	Description
id	string	Unique identifier of the organization
name	string	Name of the organization
config	object	Configuration settings for the organization
createdAt	string	Creation timestamp (ISO 8601 format)
updatedAt	string	Last update timestamp (ISO 8601 format)

Fulfillment Item Object

Field	Type	Description
product	Product Object	Details about the product
channelFulfillmentItemId	string	External channel's item identifier
quantity	integer	Quantity of the item
meta	object	Additional metadata associated with the item

Product Object

Field	Type	Description
id	string	Unique identifier of the product
organization	object	Organization that owns the product
recordType	string	Type of product record
sku	string	Stock keeping unit
brand	object	Brand information
gtin	string	Global Trade Item Number
name	string	Product name
remarks	string	Additional remarks about the product
imageMain	string	URL of the main product image
packageLengthMm	number	Package length in millimeters
packageWidthMm	number	Package width in millimeters
packageHeightMm	number	Package height in millimeters
shippingWeightKg	number	Shipping weight in kilograms
caseUnit	string	Unit of measurement for cases
casePack	integer	Number of items per case
caseLengthMm	number	Case length in millimeters
caseWidthMm	number	Case width in millimeters
caseHeightMm	number	Case height in millimeters
caseWeightKg	number	Case weight in kilograms
condition	string	Product condition (e.g., "NEW", "REFURBISHED")
serialNumberRequired	boolean	Whether serial number is required
expiryDateRequired	boolean	Whether expiry date is required
hsCode	string	Harmonized System code

Response Example

json

{
  "id": "9b49cebd-8252-44e2-ae91-f87d9e21e972",
  "status": "CREATED",
  "address": {
    "type": "UNSPECIFIED",
    "name": "test",
    "company": "test company",
    "address1": "test address",
    "address2": "test address2",
    "address3": "",
    "city": "test city",
    "state": "test",
    "postalCode": "123456",
    "countryId": "CN",
    "phone": "123456",
    "email": ""
  },
  "channelFulfillmentId": null,
  "meta": {},
  "warehouse": {
    "id": "0b6eaafa-565f-4989-b3d5-98e871f9ec25",
    "organization": {
      "id": "e4affb47-1971-42bb-97a3-215d9bddd0ac",
      "name": "Sellersoft",
      "config": {
        "wmsDisabled": false,
        "s3Type": "DEFAULT"
      },
      "createdAt": "2024-03-05T22:16:05.692314Z",
      "updatedAt": "2024-04-09T21:15:15.615765Z"
    },
    "name": "Markham Warehouse",
    "address": {
      "type": "UNSPECIFIED",
      "name": "Fabian Bai",
      "company": "Ventmere",
      "address1": "145 idema road",
      "address2": "",
      "address3": "",
      "city": "Markham",
      "state": "ON",
      "postalCode": "L3R 1A9",
      "countryId": "CA",
      "phone": "",
      "email": ""
    },
    "dropshipper": true,
    "fulfillmentCenter": true,
    "rmaCenter": true,
    "unitSystem": "METRIC",
    "createdAt": "2024-03-05T22:16:48.618677Z",
    "updatedAt": "2024-03-05T22:16:48.618677Z",
    "endOfDayTime": null,
    "timezone": null,
    "wmsDisabled": false
  },
  "warehousePickId": "621c51d2-7f20-4cfd-98d5-217503bc19da",
  "warehousePickStatus": "PENDING",
  "shippingMethod": "Standard",
  "signatureRequired": null,
  "items": [
    {
      "product": {
        "id": "1cf9a1b4-8358-4f94-890a-4a96a6d58167",
        "organization": {
          "id": "1651b1eb-6bc0-48d1-a581-2c972269070e",
          "name": "Healthcare Cargo, LLC",
          "config": {
            "wmsDisabled": false,
            "s3Type": "DEFAULT"
          },
          "createdAt": "2025-01-15T08:33:51.451698Z",
          "updatedAt": "2025-01-15T08:33:51.451698Z"
        },
        "recordType": "REGULAR",
        "sku": "NW-EKT20-SW",
        "brand": {
          "id": "e0cbbf33-cbea-4867-9fd9-5d72f22c2321",
          "name": "Sony",
          "nameNormalized": "sony",
          "createdAt": "2024-06-04T03:16:22.617577Z"
        },
        "gtin": "9038662051697",
        "name": "Intelligent Wooden Bench",
        "remarks": "Necessitatibus in et in ad.",
        "imageMain": "https://picsum.photos/1920/1200",
        "packageLengthMm": 60.34318,
        "packageWidthMm": 32.498272,
        "packageHeightMm": 25.595871,
        "shippingWeightKg": 9.647605,
        "caseUnit": "EACH",
        "casePack": 6,
        "caseLengthMm": 11.025475,
        "caseWidthMm": 69.1011,
        "caseHeightMm": 73.9792,
        "caseWeightKg": 0.09474665,
        "condition": "REFURBISHED",
        "serialNumberRequired": false,
        "expiryDateRequired": false,
        "createdAt": "2025-01-15T08:43:37.033187Z",
        "updatedAt": "2025-01-15T08:43:37.033187Z",
        "otherIds": [],
        "hsCode": null
      },
      "channelFulfillmentItemId": null,
      "quantity": 2,
      "meta": {}
    }
  ],
  "notes": [],
  "createdAt": "2025-01-17T08:51:11.896416Z",
  "updatedAt": "2025-01-17T08:51:11.896416Z",
  "attachments": [],
  "shipments": [],
  "shippingQuotes": [],
  "orderOrganization": {
    "id": "1651b1eb-6bc0-48d1-a581-2c972269070e",
    "name": "Healthcare Cargo, LLC",
    "config": {
      "wmsDisabled": false,
      "s3Type": "DEFAULT"
    },
    "createdAt": "2025-01-15T08:33:51.451698Z",
    "updatedAt": "2025-01-15T08:33:51.451698Z"
  },
  "shipByDate": null,
  "deliverByDate": null,
  "customerNote": null,
  "referenceIds": ["test_osdfsdfsdfrder_id2"],
  "orderId": "ea864fe3-bddd-458f-8674-dcf804208fb2",
  "rmaId": null,
  "orderDate": "2024-04-24T06:00:33.889Z",
  "orderAccountId": "66a44482-af94-4bde-9b0f-d2d33abd2506",
  "orderChannelOrderId": "test_osdfsdfsdfrder_id2",
  "orderType": "B2C",
  "method": "SPD"
}

Fulfillment Detail API ​

Endpoint ​

Headers ​

Path Parameters ​

Response Body ​

Address Object ​

Warehouse Object ​

Organization Object ​

Fulfillment Item Object ​

Product Object ​

Response Example ​

Fulfillment Detail API

Endpoint

Headers

Path Parameters

Response Body

Address Object

Warehouse Object

Organization Object

Fulfillment Item Object

Product Object

Response Example