Create Custom Package

posthttps://api.flxpoint.com/packages/custom

Use this when you want to create package 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.

Use this endpoint to create a new custom package. If a custom package with this name already exists, a 409 - Conflict Response will be returned.

Request

Bodyapplication/json

namestringrequired

lengthnumberrequired

widthnumberrequired

heightnumberrequired

dimensionUnitstringrequired

allowedincm

weightnumberrequired

weightUnitstringrequired

allowedlbozgkg

Example request

post/packages/custom

curl -X POST "https://api.flxpoint.com/packages/custom" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "name": "string",
         "length": 0,
         "width": 0,
         "height": 0,
         "dimensionUnit": "in",
         "weight": 0,
         "weightUnit": "lb"
       }'

Example body · application/json

{
  "name": "string",
  "length": 0,
  "width": 0,
  "height": 0,
  "dimensionUnit": "in",
  "weight": 0,
  "weightUnit": "lb"
}

Responses

201Createdapplication/json

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,
  "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.

409Conflict

No schema documented for this status.

OpenAPI fragment

{
  "post": {
    "summary": "Create Custom Package",
    "description": "Use this endpoint to create a new custom package. If a custom package with this name already exists, a 409 - Conflict Response will be returned.",
    "parameters": [],
    "requestBody": {
      "description": "",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SaveCustomPackageRequest"
          },
          "examples": {
            "Example 1": {
              "value": {
                "name": "Standard Shipping",
                "length": 8.6,
                "width": 5.4,
                "height": 1.6,
                "dimensionUnit": "in",
                "weight": 0.1,
                "weightUnit": "lb"
              }
            }
          }
        }
      }
    },
    "responses": {
      "201": {
        "description": "Created",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CustomPackage"
            },
            "examples": {
              "Example 1": {
                "value": {
                  "id": 1,
                  "name": "Standard Shipping",
                  "length": 8.6,
                  "width": 5.4,
                  "height": 1.6,
                  "dimensionUnit": {
                    "handle": "inch",
                    "abbreviatedHandle": "in"
                  },
                  "weight": 0.1,
                  "weightUnit": {
                    "handle": "pound",
                    "abbreviatedHandle": "lb"
                  },
                  "createdAt": "2019-08-24T14:15:22Z",
                  "createdByUserEmail": "user123@mycompany.com",
                  "updatedAt": null
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "Bad Request"
      },
      "401": {
        "description": "Unauthorized"
      },
      "409": {
        "description": "Conflict"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight