Origin Schedule Configuration API

Create and modify network origin schedules with Shipium's Origin Schedule Configuration API.

Suggest Edits

Get started

To use the Origin Schedule Configuration API, you can follow the instructions on this page. More information about the Origin Schedule Configuration API can be found in Configuration APIs. In addition, if you prefer to configure your origin schedules via the Shipium Console, you can find guidance for doing so in the Origin Schedule documentation.

❗️

Warning: potential negative impact on your fulfillment operations

This API can modify elements of your organization's network fulfillment configuration in ways that could negatively impact the production of your fulfillment operations. You should only use the API if you are familiar with how any changes you make could affect your network fulfillment configuration.

Configure origin schedules with the Origin Schedule Configuration API

The Origin Schedule Configuration API assumes you're using one of the authentication mechanisms detailed in our authentication documentation. The general endpoint for Origin Configuration calls is included in the table below.

API typeAPI endpoint
POSThttps://api.shipium.com/api/v1/partnerConfiguration/origins/{originId}/schedule/entry

📘

Authentication for API calls

In the cURL examples on this page, the environment variable AUTHSTRING is used to handle authorization. The recipe below shows how to set it correctly for both API Key and OAuth users.

🔐
Authenticating for Curl
Open Recipe

👉

How to use test mode

Want to run some examples and not charge any real money against your account?

You can add "testMode": "true" to a call, and it will be evaluated for correctness but not applied. You can use this for validating that your calls work without making actual changes.

The examples below all contain the testMode flag to err on the side of caution – you should remove this to make production calls.

The following table provides the required and optional fields for calling the Origin Schedule Configuration API. Path elements are described for each use case in the sections that follow.

Request fieldRequired/OptionalField propertiesDescription
carrierSchedules.carrierIdRequiredStringInternal carrier account ID as represented in Shipium; see Supported Carriers for carrier IDs.
carrierSchedules.carrierScheduleIdOptionalStringIdentifier used to refer to a specific carrier schedule; if you do not provide this value, a unique ID will be generated. Uniqueness is guaranteed; if two IDs collide, one of them will be updated to a unique ID.
carrierSchedules .carrierServiceMethodIdsOptionalStringThe set of carrier service methods that should use this schedule; each item in this list must map to an internal Shipium ID that represents a carrier service method. If this is null or empty, all of this carrier's shipment methods without a schedule will use this schedule. See Supported Carriers for carrier service method IDs.
carrierSchedules.cutoffExceptions .cutoffOptionalStringSpecifies dates when either no service is available or a different cutoff should be used instead of the one specified in cutoff times
carrierSchedules.cutoffExceptions .dateRequiredString
Ex.: 2022-12-24		The date with the changed cutoff time
carrierSchedules.cutoffTimes .cutoffRequiredStringThe final time when a shipment for a carrier or shipment method departs for the specified day
carrierSchedules.cutoffTimes .dayOfWeekRequiredString
Values are:

- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
- Sunday		The day of the week to which this cutoff applies
fromRequiredStringDate of the starting boundary of the active schedule
holidays.dateRequiredString
Ex.: 2020-07-04		The date of the holiday
holidays.metadata.additionalProp1OptionalStringA map of properties to save along with this date
processingCutoff.expectedDaysToShipRequiredInteger ($int32)The number of days that are needed for a fulfillment center to process a shipment
processingCutoff.shippingCutoffHourRequiredInteger ($int32)
Values are limited to a minimum of 0 and a maximum of 23.		The hour where requests will need an additional day for processing
processingCutoff.weekendCutoffHourRequiredInteger ($int32)
Values are limited to a minimum of 0 and a maximum of 23.		When present, overrides the hour where requests will need an additional day for processing for weekend days
shippingDaysRequiredString
Values are:

- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
- Sunday		List of days on which to ship
toRequiredStringDate of the end boundary of the active schedule

Create an origin schedule entry

The endpoint for creating an origin schedule entry is provided below.

Path

POST https://api.shipium.com/api/v1/partnerConfiguration/origins

Required path element: originId (a string ID for the origin with which this schedule entry is to be associated at creation)

Example cURL call

This example shows a request to create an origin schedule:

curl --request POST \ 
  --url <<api_url>>/api/v1/partnerConfiguration/origins/{originId}/schedule/entry \
  --header 'accept: application/json' \
  --header $AUTHSTRING \
  --header 'content-type: application/json' \
  --data 'INSERT CONTENTS FROM BELOW'

Example request body

This example shows the JSON request:

{
  "carrierSchedules": [
    {
      "carrierId": "usps",
      "carrierScheduleId": "usps-reno-fc-schedule",
      "carrierServiceMethodIds": [
        "usps-ground-advantage-service-method, usps-priority-mail-service-method"
      ],
      "cutoffExceptions": [
        {
          "cutoff": "15:30",
          "date": "2022-12-24"
        }
      ],
      "cutoffTimes": [
        {
          "cutoff": "13:45",
          "dayOfWeek": "FRIDAY"
        }
      ]
    }
  ],
  "from": "2023-05-23T19:51:31.175Z",
  "holidays": [
    {
      "date": "2020-07-04",
      "metadata": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "processingCutoff": {
    "expectedDaysToShip": 0,
    "shippingCutoffHour": 0,
    "weekendCutoffHour": 0
  },
  "shippingDays": [
    "FRIDAY"
  ],
  "to": "2023-05-23T19:51:31.175Z"
}

Example response body

{
  "carrierSchedules": [
    {
      "carrierId": "usps",
      "carrierScheduleId": "usps-reno-fc-schedule",
      "carrierServiceMethodIds": [
        "usps-ground-advantage-service-method, usps-priority-mail-service-method"
      ],
      "cutoffExceptions": [
        {
          "cutoff": "15:30",
          "date": "2022-12-24"
        }
      ],
      "cutoffTimes": [
        {
          "cutoff": "13:45",
          "dayOfWeek": "FRIDAY"
        }
      ]
    }
  ],
  "from": "2023-05-23T20:07:04.353Z",
  "holidays": [
    {
      "date": "2020-07-04",
      "metadata": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "orchestratedAssetMetadata": {
    "orchestrationId": "4ad3b5d5-f256-4184-b9af-15ccca60ea99",
    "orchestrationTimeStamp": "2023-05-23T20:07:04.353Z"
  },
  "processingCutoff": {
    "expectedDaysToShip": 0,
    "shippingCutoffHour": 0,
    "weekendCutoffHour": 0
  },
  "scheduleEntryId": "7fc6c76b-e681-4ce0-80ce-e439b76d3977",
  "shippingDays": [
    "FRIDAY"
  ],
  "to": "2023-05-23T20:07:04.353Z"
}

Retrieve all origin schedules for an origin

Path

GET
<<api_url>>/api/v1/partnerConfiguration/origins/{originId}/schedule

Required path element: originId (a string ID for the origin with which this schedule entry is associated)

Example request body

The request body is empty for this call.

Example response body

{
  "orchestratedAssetMetadata": {
    "orchestrationId": "8205a8b7-1f69-4479-b559-731d309beb60",
    "orchestrationTimeStamp": "2023-05-23T20:10:39.342Z"
  },
  "results": [
    {
      "carrierSchedules": [
        {
          "carrierId": "usps",
          "carrierScheduleId": "usps-reno-fc-schedule",
          "carrierServiceMethodIds": [
            "usps-ground-advantage-service-method, usps-priority-mail-service-method"
          ],
          "cutoffExceptions": [
            {
              "cutoff": "15:30",
              "date": "2022-12-24"
            }
          ],
          "cutoffTimes": [
            {
              "cutoff": "13:45",
              "dayOfWeek": "FRIDAY"
            }
          ]
        }
      ],
      "from": "2023-05-23T20:10:39.342Z",
      "holidays": [
        {
          "date": "2020-07-04",
          "metadata": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        }
      ],
      "orchestratedAssetMetadata": {
        "orchestrationId": "8205a8b7-1f69-4479-b559-731d309beb60",
        "orchestrationTimeStamp": "2023-05-23T20:10:39.342Z"
      },
      "processingCutoff": {
        "expectedDaysToShip": 0,
        "shippingCutoffHour": 0,
        "weekendCutoffHour": 0
      },
      "scheduleEntryId": "b6268dd4-0c89-4d4c-848c-9b51f817da98",
      "shippingDays": [
        "FRIDAY"
      ],
      "to": "2023-05-23T20:10:39.342Z"
    }
  ]
}

Delete an origin schedule entry by schedule entry ID

Path

DELETE
<<api_url>>/api/v1/partnerConfiguration/origins/{originId}/schedule/entry/{originScheduleEntryId}

Required path element: originId (a string ID for the origin with which this schedule entry is associated)

Required path element: originScheduleEntryId (a string ID for the origin schedule entry with which this schedule entry is associated)

Example request body

The request body is empty for this call.

Example response body

{
  "carrierSchedules": [
    {
      "carrierId": "usps",
      "carrierScheduleId": "usps-reno-fc-schedule",
      "carrierServiceMethodIds": [
        "usps-ground-advantage-service-method, usps-priority-mail-service-method"
      ],
      "cutoffExceptions": [
        {
          "cutoff": "15:30",
          "date": "2022-12-24"
        }
      ],
      "cutoffTimes": [
        {
          "cutoff": "13:45",
          "dayOfWeek": "FRIDAY"
        }
      ]
    }
  ],
  "from": "2023-05-23T20:13:58.563Z",
  "holidays": [
    {
      "date": "2020-07-04",
      "metadata": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "orchestratedAssetMetadata": {
    "orchestrationId": "3f1b036b-4ec3-48c3-be18-8a261364f02c",
    "orchestrationTimeStamp": "2023-05-23T20:13:58.563Z"
  },
  "processingCutoff": {
    "expectedDaysToShip": 0,
    "shippingCutoffHour": 0,
    "weekendCutoffHour": 0
  },
  "scheduleEntryId": "ae73cc23-7146-4b2c-ab2b-d91be4ce884e",
  "shippingDays": [
    "FRIDAY"
  ],
  "to": "2023-05-23T20:13:58.563Z"
}

Update an existing origin schedule

Making updates to an existing origin schedule is currently managed by deleting the existing origin schedule and creating a new origin schedule.

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful:

Updated 15 days ago

What’s Next