FlxpointAPI Help CenterBeta

Add Source Shipping Method

posthttps://api.flxpoint.com/shipping/source-shipping-methods

Use this when you want to create shipping data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Request

Bodyapplication/json
sourceIdinteger
Required if not using a source token.
descriptionstringrequired
shippingPolicyIdintegerrequired
carrierstring
methodstring
shippingCodestringdeprecated
Deprecated. Use `defaultMethodCode` instead.
shippingCarrierIdintegerdeprecated
Deprecated. Use `shippingCarrierIds` instead.
shippingCarrierMethodIdintegerdeprecated
Deprecated. Use `shippingCarrierMethodIds` instead.
shippingLabelCodestring
It is used to specify the preferred Delivery Service during the purchase of a shipping label when a Fulfillment Request is not rate shopped
defaultCarrierCodestring
defaultMethodCodestring
overrideDefaultCodesboolean
filterCarriersAndMethodsboolean
shippingCarrierIdsarray[integer]
integer
shippingCarrierMethodIdsarray[integer]
integer
useBestFitPackageboolean
commonPackageIdsarray[integer]
integer
customPackageIdsarray[integer]
integer

Example request

post/shipping/source-shipping-methods
curl -X POST "https://api.flxpoint.com/shipping/source-shipping-methods" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "sourceId": 0,
         "description": "string",
         "shippingPolicyId": 0,
         "carrier": "string",
         "method": "string",
         "shippingCode": "string",
         "shippingCarrierId": 0,
         "shippingCarrierMethodId": 0,
         "shippingLabelCode": "string",
         "defaultCarrierCode": "string",
         "defaultMethodCode": "string",
         "overrideDefaultCodes": true,
         "filterCarriersAndMethods": true,
         "shippingCarrierIds": [
           0
         ],
         "shippingCarrierMethodIds": [
           0
         ],
         "useBestFitPackage": true,
         "commonPackageIds": [
           0
         ],
         "customPackageIds": [
           0
         ]
       }'
Example body · application/json
{
  "sourceId": 0,
  "description": "string",
  "shippingPolicyId": 0,
  "carrier": "string",
  "method": "string",
  "shippingCode": "string",
  "shippingCarrierId": 0,
  "shippingCarrierMethodId": 0,
  "shippingLabelCode": "string",
  "defaultCarrierCode": "string",
  "defaultMethodCode": "string",
  "overrideDefaultCodes": true,
  "filterCarriersAndMethods": true,
  "shippingCarrierIds": [
    0
  ],
  "shippingCarrierMethodIds": [
    0
  ],
  "useBestFitPackage": true,
  "commonPackageIds": [
    0
  ],
  "customPackageIds": [
    0
  ]
}

Responses

201Createdapplication/json
idinteger
sourceIdinteger
descriptionstring
carrierstring
methodstring
shippingCodestringdeprecated
Deprecated. Use `defaultMethodCode` instead.
shippingPolicyobject
idinteger
namestringrequired
deletedAtstring (date-time)
deletedAtstring (date-time)
shippingCarrierobject
idinteger
namestring
handlestring
shipEngineSupportedboolean
shippingCarrierMethodobject
idinteger
shippingCarrierobject
idinteger
namestring
handlestring
shipEngineSupportedboolean
namestring
handlestring
shippingLabelCodestring
It is used to specify the preferred Delivery Service during the purchase of a shipping label when a Fulfillment Request is not rate shopped
defaultCarrierCodestring
The code (text) that your source recognizes for this shipping carrier.
defaultMethodCodestring
Formally known as "Shipping Code". The code (text) that your source recognizes for this shipping method.
overrideDefaultCodesboolean
Use codes provided by ShipEngine to send to your source based on the carrier and method with the best shipping rate.
default false
filterCarriersAndMethodsboolean
Filter to include only some carriers and methods you've connected to ShipEngine.
default false
shippingCarriersarray[ShippingCarrier]
When filtering shipping carriers and methods (i.e. filterCarriersAndMethods = true), this is the list of eligible shipping carriers that may be used for shipping. <b>Note:</b> When filterCarriersAndMethods = false, this list will be empty, but <b>all</b> carriers will be considered for rate shopping.
idinteger
namestring
handlestring
shipEngineSupportedboolean
shippingCarrierMethodsarray[ShippingCarrierMethod]
When filtering shipping carriers and methods (i.e. filterCarriersAndMethods = true), this is the list of eligible methods that may be used for shipping. <b>Note:</b> When filterCarriersAndMethods = false, this list will be empty, but <b>all</b> methods for all carriers will be considered for rate shopping.
idinteger
shippingCarrierobject
idinteger
namestring
handlestring
shipEngineSupportedboolean
namestring
handlestring
useBestFitPackageboolean
Use Flxpoint's predefined package sizes to fit all PO/FR line items in a single package. The largest box possible will be used for oversized PO/FRs. When false, package sizes must be configured for eligibility during rate shopping. You may select any number of common packages and/or use your own custom packages.
default true
commonPackagesarray[CommonPackage]
This will contain the <b>standard</b> package selections enabled for use with this shipping method when configured to use specific packages for shipping, rather than Flxpoint's predefined "Best Fit" package sizes (i.e. useBestFitPackage = false). <b>Note:</b> When useBestFitPackage = true, this list will be empty, and Flxpoint's predefined list of packages will be considered instead.
idinteger
A unique, numerical identifier for the package.
lengthnumber
The length dimension of the package.
widthnumber
The width dimension of the package.
heightnumber
The height dimension of the package.
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
weightnumber
The weight of the package itself (excluding any contents).
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
customPackagesarray[CustomPackage]
This will contain the <b>unique</b> package selections enabled for use with this shipping method when configured to use specific packages for shipping, rather than Flxpoint's predefined "Best Fit" package sizes (i.e. useBestFitPackage = false). <b>Note:</b> When useBestFitPackage = true, this list will be empty, and Flxpoint's predefined list of packages will be considered instead.
idinteger
A unique, numerical identifier for the package.
namestring
Your name for the package.
lengthnumber
The length dimension of the package.
widthnumber
The width dimension of the package.
heightnumber
The height dimension of the package.
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
weightnumber
The weight of the package itself (excluding any contents).
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
createdAtstring (date-time)
The time that the package was created by an account user.
createdByUserEmailstring
The email address of the user who created the package.
updatedAtstring (date-time)
The last time the package details were modified (will be null if never changed).
Example response
{
  "id": 0,
  "sourceId": 0,
  "description": "string",
  "carrier": "string",
  "method": "string",
  "shippingCode": "string",
  "shippingPolicy": {
    "id": 0,
    "name": "string",
    "deletedAt": "2026-04-20T00:00:00Z"
  },
  "deletedAt": "2026-04-20T00:00:00Z",
  "shippingCarrier": {
    "id": 0,
    "name": "string",
    "handle": "string",
    "shipEngineSupported": true
  },
  "shippingCarrierMethod": {
    "id": 0,
    "shippingCarrier": {
      "id": 0,
      "name": "string",
      "handle": "string",
      "shipEngineSupported": true
    },
    "name": "string",
    "handle": "string"
  },
  "shippingLabelCode": "string",
  "defaultCarrierCode": "string",
  "defaultMethodCode": "string",
  "overrideDefaultCodes": true,
  "filterCarriersAndMethods": true,
  "shippingCarriers": [
    {
      "id": 0,
      "name": "string",
      "handle": "string",
      "shipEngineSupported": true
    }
  ],
  "shippingCarrierMethods": [
    {
      "id": 0,
      "shippingCarrier": {
        "id": 0,
        "name": "string",
        "handle": "string",
        "shipEngineSupported": true
      },
      "name": "string",
      "handle": "string"
    }
  ],
  "useBestFitPackage": true,
  "commonPackages": [
    {
      "id": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "dimensionUnit": {
        "handle": "inch",
        "abbreviatedHandle": "in"
      },
      "weight": 0,
      "weightUnit": {
        "handle": "pound",
        "abbreviatedHandle": "lb"
      }
    }
  ],
  "customPackages": [
    {
      "id": 0,
      "name": "string",
      "length": 0,
      "width": 0,
      "height": 0,
      "dimensionUnit": {
        "handle": "inch",
        "abbreviatedHandle": "in"
      },
      "weight": 0,
      "weightUnit": {
        "handle": "pound",
        "abbreviatedHandle": "lb"
      },
      "createdAt": "2026-04-20T00:00:00Z",
      "createdByUserEmail": "string",
      "updatedAt": "2026-04-20T00:00:00Z"
    }
  ]
}
400Bad Request

No schema documented for this status.

401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment
{
  "post": {
    "summary": "Add Source Shipping Method",
    "description": "",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SaveSourceShippingMethodRequest"
          }
        }
      }
    },
    "responses": {
      "201": {
        "description": "Created",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SourceShippingMethod"
            }
          }
        }
      },
      "400": {
        "description": "Bad Request"
      },
      "401": {
        "description": "Unauthorized"
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}
Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight