fabric service for Shipping Methods (2.0.0)

Download OpenAPI specification:Download

fabric provides multi-carrier shipping and logistics solution to address all of your common shipping issues, without the addition of expensive infrastructure. You can explore various shipping methods with rates, and configure them to your ecommerce store. This will help provide your customers with options that are most suitable for their needs, since some are willing to add additional items to the cart in order to qualify for free shipping, while others are willing to pay more for same-day or next-day delivery. Therefore, offering the right options is crucial for a delightful shopping experience. Shipping rates are the most crucial part of shipping methods and are dependent on shipment's dimensions, weight, size, source of origin and destination, and type of packaging.

Shipping Method

Endpoints to perform operations related to shipping methods

Create shipping method

Creates shipping method. Response includes shippingMethodId, which is required for subsequent calls such as GET /{shipmethodId}, PATCH/{shipmethodId}, DELETE /{shipmethodId}, and GET /{shipMethodId}/items.

SecurityAuthorization
Request
header Parameters
required
object (XSiteContext)

Represents single or multi-tenancy

Request Body schema: application/json
shippingMethodId
string

24-character system-generated unique shipping method ID. Optional in the request body

name
required
string

Shipping method name

description
required
string

Brief description of shipping method

taxCode
required
string

Tax code based on the state

minimumDays
required
integer <int32>

Minimum days for delivery

maximumDays
required
integer <int32>

Maximum days for delivery

cutOffTime
required
integer <int32>

Cut off delivery time

cost
required
number

Shipping cost

channel
required
string

Sales channel

region
string

Region or state of shipping

deleted
boolean

true: Shipping method is deleted
false: Shipping method is active

createdBy
required
string

User who created the shipping method

updatedBy
string

User who last modified the shipping method

configuredBy
string

User who configured the shipping method

addressType
required
string

Address type of delivery

object (MinMaxValue)

Min-max value

object (MinMaxValue)

Min-max value

object (MinMaxDimension)

Min-Max dimension details

createdAt
string <date-time>

Time of shipping method creation

updatedAt
string <date-time>

Time of shipping method creation

Responses
200

OK

400

Bad Request

404

Ship method Not Found

500

Internal Server Error

post/
Request samples
application/json
{
  • "shippingMethodId": "5349b4ddd2781d08c09890f4",
  • "name": "Express Delivery",
  • "description": "Express Delivery 2 - 5 days",
  • "taxCode": "tax_1",
  • "minimumDays": 2,
  • "maximumDays": 5,
  • "cutOffTime": 1330,
  • "cost": 20,
  • "channel": "12",
  • "region": "CA",
  • "deleted": false,
  • "createdBy": "User1",
  • "updatedBy": "User2",
  • "configuredBy": "User3",
  • "addressType": "APO",
  • "weight": {
    },
  • "cartValue": {
    },
  • "dimension": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "shippingMethodId": "5349b4ddd2781d08c09890f4",
  • "name": "Express Delivery",
  • "description": "Express Delivery 2 - 5 days",
  • "taxCode": "tax_1",
  • "minimumDays": 2,
  • "maximumDays": 5,
  • "cutOffTime": 1330,
  • "cost": 20,
  • "channel": "12",
  • "region": "CA",
  • "deleted": false,
  • "createdBy": "User1",
  • "updatedBy": "User2",
  • "configuredBy": "User3",
  • "addressType": "APO",
  • "weight": {
    },
  • "cartValue": {
    },
  • "dimension": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get shipping method

Gets details of a shipping method by its ID.

SecurityAuthorization
Request
path Parameters
shipmethodId
required
string

24-character system-generated unique ID of shipping method

header Parameters
required
object (XSiteContext)

Represents single or multi-tenancy

Responses
200

OK

400

Bad Request

404

ShipMethod Not Found!

500

Internal Server Error

get/{shipmethodId}
Response samples
application/json
{
  • "shippingMethodId": "5349b4ddd2781d08c09890f4",
  • "name": "Express Delivery",
  • "description": "Express Delivery 2 - 5 days",
  • "taxCode": "tax_1",
  • "minimumDays": 2,
  • "maximumDays": 5,
  • "cutOffTime": 1330,
  • "cost": 20,
  • "channel": "12",
  • "region": "CA",
  • "deleted": false,
  • "createdBy": "User1",
  • "updatedBy": "User2",
  • "configuredBy": "User3",
  • "addressType": "APO",
  • "weight": {
    },
  • "cartValue": {
    },
  • "dimension": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete shipping method

Deletes a shipping method by its ID

SecurityAuthorization
Request
path Parameters
shipmethodId
required
string

24-character system-generated unique ID of shipping method

Example: 62fa3796841ea417fa71d2a9
header Parameters
required
object (XSiteContext)

Represents single or multi-tenancy

Responses
200

OK

400

Bad Request

404

ShipMethod Not Found!

500

Internal Server Error

delete/{shipmethodId}
Response samples
application/json
{
  • "shippingMethodId": "5349b4ddd2781d08c09890f4",
  • "name": "Express Delivery",
  • "description": "Express Delivery 2 - 5 days",
  • "taxCode": "tax_1",
  • "minimumDays": 2,
  • "maximumDays": 5,
  • "cutOffTime": 1330,
  • "cost": 20,
  • "channel": "12",
  • "region": "CA",
  • "deleted": false,
  • "createdBy": "User1",
  • "updatedBy": "User2",
  • "configuredBy": "User3",
  • "addressType": "APO",
  • "weight": {
    },
  • "cartValue": {
    },
  • "dimension": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update shipping method

Updates shipping method by its Id

SecurityAuthorization
Request
path Parameters
shipmethodId
required
string

24-character system-generated unique ID of shipping method

Example: 62fa3796841ea417fa71d2a9
header Parameters
required
object (XSiteContext)

Represents single or multi-tenancy

Request Body schema: application/json
shippingMethodId
string

24-character system-generated unique shipping method ID. Optional in the request body

name
required
string

Shipping method name

description
required
string

Brief description of shipping method

taxCode
required
string

Tax code based on the state

minimumDays
required
integer <int32>

Minimum days for delivery

maximumDays
required
integer <int32>

Maximum days for delivery

cutOffTime
required
integer <int32>

Cut off delivery time

cost
required
number

Shipping cost

channel
required
string

Sales channel

region
string

Region or state of shipping

deleted
boolean

true: Shipping method is deleted
false: Shipping method is active

createdBy
required
string

User who created the shipping method

updatedBy
string

User who last modified the shipping method

configuredBy
string

User who configured the shipping method

addressType
required
string

Address type of delivery

object (MinMaxValue)

Min-max value

object (MinMaxValue)

Min-max value

object (MinMaxDimension)

Min-Max dimension details

createdAt
string <date-time>

Time of shipping method creation

updatedAt
string <date-time>

Time of shipping method creation

Responses
200

OK

400

Bad Request

404

ShipMethod Not Found!

500

Internal Server Error

patch/{shipmethodId}
Request samples
application/json
{
  • "shippingMethodId": "5349b4ddd2781d08c09890f4",
  • "name": "Express Delivery",
  • "description": "Express Delivery 2 - 5 days",
  • "taxCode": "tax_1",
  • "minimumDays": 2,
  • "maximumDays": 5,
  • "cutOffTime": 1330,
  • "cost": 20,
  • "channel": "12",
  • "region": "CA",
  • "deleted": false,
  • "createdBy": "User1",
  • "updatedBy": "User2",
  • "configuredBy": "User3",
  • "addressType": "APO",
  • "weight": {
    },
  • "cartValue": {
    },
  • "dimension": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "shippingMethodId": "5349b4ddd2781d08c09890f4",
  • "name": "Express Delivery",
  • "description": "Express Delivery 2 - 5 days",
  • "taxCode": "tax_1",
  • "minimumDays": 2,
  • "maximumDays": 5,
  • "cutOffTime": 1330,
  • "cost": 20,
  • "channel": "12",
  • "region": "CA",
  • "deleted": false,
  • "createdBy": "User1",
  • "updatedBy": "User2",
  • "configuredBy": "User3",
  • "addressType": "APO",
  • "weight": {
    },
  • "cartValue": {
    },
  • "dimension": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Add items to shipping methods

Associated items to a shipping method

SecurityAuthorization
Request
path Parameters
shipMethodId
required
string

24-character system-generated unique ID for shipping method

Example: 62fa3796841ea417fa71d2a9
header Parameters
required
object (XSiteContext)

Represents single or multi-tenancy

Request Body schema: application/json
itemIds
required
Array of strings

List of item IDs

Responses
200

OK

400

Bad Request

404

ShipMethod Not Found!

500

Internal Server Error

post/{shipMethodId}/item
Request samples
application/json
{
  • "itemIds": [
    ]
}
Response samples
application/json
[
  • {
    }
]

Filter shipping methods

Gets shipping method by specified filter criteria.

SecurityAuthorization
Request
header Parameters
required
object (XSiteContext)

Represents single or multi-tenancy

Request Body schema: application/json
limit
integer <int32>
Default: 10

Ending record number (from the offset number) in the response. When no value is provided, the default value is 10.

offset
integer <int64>
Default: 0

Starting number of the record (within the total number of records) in the response. Offset is zero-based. That is, the 10th record is at offset 9 starting from the 0th record. When no value is provided, the default value is 0

sortBy
required
string
Default: "createdAt"

Sorting criteria

sortDirection
string
Default: "asc"

Sorting direction - ascending or descending

Enum: "asc" "desc"
required
object
Default: {}
Responses
200

OK

400

Bad Request

404

ShipMethod Not Found!

500

Internal Server Error

post/query
Request samples
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "sortBy": "createdBy",
  • "sortDirection": "desc",
  • "filters": {
    }
}
Response samples
application/json
{
  • "count": 100,
  • "limit": 10,
  • "offset": 1
}

Get ItemIds for a shipping method

Gets items associated with a shipping method

SecurityAuthorization
Request
path Parameters
shipMethodId
required
string

24-character system-generated shipping method ID

Example: 62fa3796841ea417fa71d2a9
query Parameters
limit
string

Ending record number (from the offset number) in the response. When no value is provided, the default value is 10.

Example: limit=10
offset
string

Starting number of the record (within the total number of records) in the response. Offset is zero-based. That is, the 10th record is at offset 9 starting from the 0th record. When no value is provided, the default value is 0

Example: offset=0
header Parameters
required
object (XSiteContext)

Represents single or multi-tenancy

Responses
200

OK

400

Bad Request

404

ShipMethod Not Found!

500

Internal Server Error

get/{shipMethodId}/items
Response samples
application/json
{
  • "count": 100,
  • "limit": 10,
  • "offset": 1,
  • "itemIds": [
    ]
}

Get shipping methods for an item

Gets shipping methods for an item

SecurityAuthorization
Request
path Parameters
itemId
required
string

Item ID

Example: 1234
header Parameters
required
object (XSiteContext)

Represents single or multi-tenancy

Responses
200

OK

400

Bad Request

404

ShipMethod Not Found!

500

Internal Server Error

get/shippingMethods/{itemId}
Response samples
application/json
{
  • "shippingMethods": [
    ]
}