Get started

To use the Origin Configuration API, you can follow the instructions on this page. More information about the Origin Configuration API can be found in Configuration APIs. In addition, if you prefer to configure your origins via the Shipium Console, you can find guidance for doing so in the Origins 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 origins with the Origin Configuration API

The Origin 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 type	API endpoint
POST	https://api.shipium.com/api/v1/partnerConfiguration/origins

📘
Authentication for API Calls
In the cURL example 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 equired and optional fields for calling the Origin Configuration API. Path elements are described for each use case in the sections that follow.

Request field	Required/Optional	Field properties	Description
`originType`	Required	String Values are: - fc - store - at_large	The type of origin; `fc` refers to fulfillment center, `store` refers to locations that may ship and also interact directly with customers, and `at_large` refers to a special case for providing data that is used for shipping from locations that are NOT fulfillment centers or stores (e.g., shipping from a dropship partner not configured as a fulfillment center).
`partnerProvidedId`	Optional	String	Unique to the asset ID that is provided by your organization; this ID gives the you the ability to set your own IDs for assets within the Shipium platform.
`name`	Optional	String	The name of the origin
`description`	Optional	String	A description of the origin
`contact`		Object	contact has four elements referring to the contact for this origin. fullName - the full name of the contact emailAddress - the email address of the contact phoneNumber - the phone number associated with the contact phoneNumberCountryCode: - an optional field for the phone country code associated with the phone number, e.g. "+1"
`address`		Object	address has nine elements referring to the address for this origin. city - the name of the city for the address company - the company associated with the address countryCode - the 2-character country code of the address name - the name of the origin address postalCode - a country-code-appropriate postal code for the address state - the 2-letter postal abbreviation of the state for the address street1 - the first address line street2 - the second address line addressLineComponents - an object whose components are defined in the row below Note: You may include either the street1* and street2 values OR you can include the addressLineComponents values (defined below). However, you can't include both in the same call.*
`address .addressLineComponents`		Object	addressLineComponents has five elements referring to the address for this origin. streetName - the name of the street for the address primaryAddressNumber - the primary number for the address secondaryAddressNumber - the secondary number for the address district - the district for the address neighborhood - the neighborhood name for the address

Create an origin

The endpoint for creating an origin is provided below, along with the optional parameter for associating a tenant with the origin, if your organization employs tenants. You can find information on tenants within the Shipium platform in the Tenant Details documentation.

Path

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

Required path element: originId

Optional parameter: tenantId (a string ID for the tenant with which this origin is to be associated at creation)

Example cURL call

This example shows a request to create an origin:

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

Example request body using street1 and street2

This example shows the JSON request for creating an origin using the street 1 and street 2 fields for the address object:

{
  "address": {
    "city": "Reno",
    "company": "Shipium",
    "countryCode": "US",
    "name": "Reno Address",
    "postalCode": "89433",
    "state": "NV",
    "street1": "123 Shipium Way",
    "street2": "Building 123"
  },
  "contact": {
    "email": "[email protected]",
    "fullName": "Shippy Shipium",
    "name": "Reno Contact",
    "phoneNumber": "2223334444"
  },
  "description": "Reno Fulfillment Center",
  "name": "Reno Fulfillment Center",
  "originType": "at_large",
  "partnerProvidedId": "rno_fulfillment_center"
}

Example response body using street1 and street2

{
    "address": {
        "city": "Reno",
        "company": "Shipium",
        "countryCode": "US",
        "name": "Reno Address",
        "postalCode": "89433",
        "state": "NV",
        "street1": "123 Shipium Way",
        "street2": "Building 123"
    },
    "contact": {
        "email": "[email protected]",
        "fullName": "Shippy Shipium",
        "name": "Reno Contact",
        "phoneNumber": "2223334444"
    },
    "description": "Reno Fulfillment Center",
    "href": "https://partner-management-service.stage.shipium.com/api/v1/partnerConfiguration/origins/5ddf6ced-eed2-4cec-bb7e-5cde30959843",
    "name": "Reno Fulfillment Center",
    "orchestratedAssetMetadata": {
        "orchestrationId": "4ad3b5d5-f256-4184-b9af-15ccca60ea99",
        "orchestrationTimeStamp": "2024-04-16T20:37:01.818Z"
    },
    "originId": "5ddf6ced-eed2-4cec-bb7e-5cde30959843",
    "originType": "at_large",
    "partnerId": "76abb3d4-8990-4f80-aa13-4c2007cb852a",
    "partnerProvidedId": "rno_fulfillment_center",
    "scheduleConfigured": false
}

Example request body using addressLineComponents

This is a sample request including the addressLineComponents values:

{
  "address": {
    "city": "Mexico City",
    "company": "Shipium",
    "countryCode": "MX",
    "name": "Mexico City Address",
    "postalCode": "14410",
    "state": "CDMX",
    "addressLineComponents": {
        "streetName": "Fovisste Fuentes Brotantes",
        "primaryAddressNumber": "D-1",
        "secondaryAddressNumber": "302",
        "district": "Tlalpan",
        "neighborhood": "Miguel Hidalgo"
    }
  },
  "contact": {
    "email": "[email protected]",
    "fullName": "Shippy Shipium",
    "name": "Mexico City Contact",
    "phoneNumber": "2223334444",
    "phoneNumberCountryCode": "+52"
  },
  "description": "Mexico City Fulfillment Center",
  "name": "Mexico City Fulfillment Center",
  "originType": "fc",
  "partnerProvidedId": "cdmx_fulfillment_center"
}

Example response body using addressLineComponents

This example shows a JSON response for the request including addressLineComponents:

{
    "address": {
        "addressLineComponents": {
            "district": "Tlalpan",
            "neighborhood": "Miguel Hidalgo",
            "primaryAddressNumber": "D-1",
            "secondaryAddressNumber": "302",
            "streetName": "Fovisste Fuentes Brotantes"
        },
        "city": "Mexico City",
        "company": "Shipium",
        "countryCode": "MX",
        "name": "Mexico City Address",
        "postalCode": "14410",
        "state": "CDMX"
    },
    "contact": {
        "email": "[email protected]",
        "fullName": "Shippy Shipium",
        "name": "Mexico City Contact",
        "phoneNumber": "2223334444",
        "phoneNumberCountryCode": "+52"
    },
    "description": "Mexico City Fulfillment Center",
    "href": "https://partner-management-service.stage.shipium.com/api/v1/partnerConfiguration/origins/befb6619-c4ae-4af6-939c-590782c7b384",
    "name": "Mexico City Fulfillment Center",
    "orchestratedAssetMetadata": {
        "orchestrationId": "369e6293-2065-4717-a482-68d53f62cfed",
        "orchestrationTimeStamp": "2024-04-16T15:52:35.032Z"
    },
    "originId": "43216619-c4ae-4af6-939c-590782c7b384",
    "originType": "fc",
    "partnerId": "1234b3d4-8990-4f80-aa13-4c2007cb852a",
    "partnerProvidedId": "cdmx_fulfillment_center",
    "scheduleConfigured": false
}

Retrieve a specific origin by ID

Path

GET https://api.shipium.com/api/v1/partnerConfiguration/origins/{originId}

Required path element: originId

Optional parameter: tenantId (a string ID for the tenant with which this origin is to be associated at creation)

Example request body

The request body is empty for this call.

Example response body

{
  "activeSchedule": {
    "from": "2022-10-17T22:33:42.548Z",
    "holidays": [
      {
        "date": "2020-07-04",
        "metadata": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      }
    ],
    "processingCutoff": {
      "expectedDaysToShip": 0,
      "shippingCutoffHour": 0,
      "weekendCutoffHour": 0
    },
    "shippingDays": [
      "FRIDAY"
    ],
    "to": "2022-10-17T22:33:42.549Z"
  },
  "address": {
    "addressType": "residential",
    "name": "Reno Address",
    "company": "Shipium",
    "street1": "123 Shipium Way",
    "street2": "Building 123",
    "city": "Reno",
    "state": "NV",
    "countryCode": "US",
    "postalCode": "89433"
  },
  "contact": {
    "email": "[email protected]",
    "name": "Reno Contact",
    "phoneNumber": "2223334444"
  },
  "description": "Reno Fulfillment Center",
  "href": "https://partner-management-service.stage.shipium.com/api/v1/partnerConfiguration/origins/5ddf6ced-eed2-4cec-bb7e-5cde30959843",
  "name": "Reno Fulfillment Center",
  "orchestratedAssetMetadata": {
    "orchestrationId": "4ad3b5d5-f256-4184-b9af-15ccca60ea99",
    "orchestrationTimeStamp": "2022-10-17T22:33:42.549Z"
  },
  "originId": "5ddf6ced-eed2-4cec-bb7e-5cde30959843",
  "originType": "at_large",
  "partnerId": "76abb3d4-8990-4f80-aa13-4c2007cb852a",
  "partnerProvidedId": "rno_fulfillment_center",
  "scheduleConfigured": true,
  "tenantLink": {
    "href": "https://partner-management-service.stage.shipium.com/api/v1/partnerConfiguration/origins/5ddf6ced-eed2-4cec-bb7e-5cde30959843",
    "tenantId": "f7092716-1b4b-4ce6-b4a6-e18b11f16c9d"
  }
}

Retrieve all origins

Path

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

Example request body

The request body for this call is empty.

Example response body

{
  "orchestratedAssetMetadata": {
    "orchestrationId": "4ad3b5d5-f256-4184-b9af-15ccca60ea99",
    "orchestrationTimeStamp": "2022-10-17T22:25:22.944Z"
  },
  "results": [
    {
      "activeSchedule": {
        "from": "2022-10-17T22:25:22.944Z",
        "holidays": [
          {
            "date": "2020-07-04",
                "metadata": {
                  "<optionalAdditionalProp1>": "string",
                }
          }
        ],
        "processingCutoff": {
          "expectedDaysToShip": 0,
          "shippingCutoffHour": 0,
          "weekendCutoffHour": 0
        },
        "shippingDays": [
          "FRIDAY"
        ],
        "to": "2022-10-17T22:25:22.944Z"
      },
      "address": {
        "addressType": "residential",
        "name": "Reno Address",
        "company": "Shipium",
        "street1": "123 Shipium Way",
        "street2": "Building 123",
        "city": "Reno",
        "state": "NV",
        "countryCode": "US",
        "postalCode": "89433"
      },
      "contact": {
        "email": "[email protected]",
        "name": "Reno Contact",
        "phoneNumber": "2223334444"
      },
      "description": "Reno Fulfillment Cente",
      "href": "https://partner-management-service.stage.shipium.com/api/v1/partnerConfiguration/origins/5ddf6ced-eed2-4cec-bb7e-5cde30959843",
      "name": "Reno Fulfillment Center",
      "orchestratedAssetMetadata": {
        "orchestrationId": "4ad3b5d5-f256-4184-b9af-15ccca60ea99",
        "orchestrationTimeStamp": "2022-10-17T22:25:22.944Z"
      },
      "originId": "5ddf6ced-eed2-4cec-bb7e-5cde30959843",
      "originType": "at_large",
      "partnerId": "76abb3d4-8990-4f80-aa13-4c2007cb852a",
      "partnerProvidedId": "rno_fulfillment_center",
      "scheduleConfigured": true,
      "tenantLink": {
        "href": "https://partner-management-service.stage.shipium.com/api/v1/partnerConfiguration/origins/5ddf6ced-eed2-4cec-bb7e-5cde30959843",
        "tenantId": "f7092716-1b4b-4ce6-b4a6-e18b11f16c9d"
      }
    }
  ]
}

Update an existing origin

Path

PATCH https://api.shipium.com/api/v1/partnerConfiguration/origins/{originId}

Required path element: originId

Optional parameter: tenantId (a string ID for the tenant with which this origin is to be associated at creation)

Example request body

{
  "name": "Reno Fulfillment Center",
  "description": "Reno Fulfillment Center",
  "originType": "at_large",
  "address": {
    "addressType": "residential",
    "name": "Reno Address",
    "company": "Shipium",
    "street1": "123 Shipium Way",
    "street2": "Building 123",
    "city": "Reno",
    "state": "NV",
    "countryCode": "US",
    "postalCode": "89433"
  },
  "contact": {
    "name": "Reno Contact",
    "email": "[email protected]",
    "phoneNumber": "2223334444"
  }
}

Example response body

{
  "activeSchedule": {
    "from": "2022-10-17T22:45:31.652Z",
    "holidays": [
      {
        "date": "2020-07-04"
      }
    ],
    "processingCutoff": {
      "expectedDaysToShip": 0,
      "shippingCutoffHour": 0,
      "weekendCutoffHour": 0
    },
    "shippingDays": [
      "FRIDAY"
    ],
    "to": "2022-10-17T22:45:31.652Z"
  },
  "address": {
    "addressType": "residential",
    "name": "Reno Address",
    "company": "Shipium",
    "street1": "123 Shipium Wa",
    "street2": "Building 123",
    "city": "Reno",
    "state": "NV",
    "countryCode": "US",
    "postalCode": "89433"
  },
  "contact": {
    "email": "[email protected]",
    "name": "Reno Contact",
    "phoneNumber": "2223334444"
  },
  "description": "Reno Fulfillment Center",
  "href": "https://partner-management-service.stage.shipium.com/api/v1/partnerConfiguration/origins/5ddf6ced-eed2-4cec-bb7e-5cde30959843",
  "name": "Reno Fulfillment Center",
  "orchestratedAssetMetadata": {
    "orchestrationId": "4ad3b5d5-f256-4184-b9af-15ccca60ea99",
    "orchestrationTimeStamp": "2022-10-17T22:45:31.652Z"
  },
  "originId": "5ddf6ced-eed2-4cec-bb7e-5cde30959843",
  "originType": "at_large",
  "partnerId": "76abb3d4-8990-4f80-aa13-4c2007cb852a",
  "partnerProvidedId": "rno_fulfillment_center",
  "scheduleConfigured": true,
  "tenantLink": {
    "href": "https://partner-management-service.stage.shipium.com/api/v1/partnerConfiguration/origins/5ddf6ced-eed2-4cec-bb7e-5cde30959843",
    "tenantId": "f7092716-1b4b-4ce6-b4a6-e18b11f16c9d"
  }
}

Delete an existing origin

Path

DELETE https://api.shipium.com/api/v1/partnerConfiguration/origins/{originId}

Required path element: originId

Example request body

The request body is empty for this call.

Example response body

{
  "activeSchedule": {
    "from": "2022-10-17T22:48:36.908Z",
    "holidays": [
      {
        "date": "2020-07-04"
      }
    ],
    "processingCutoff": {
      "expectedDaysToShip": 0,
      "shippingCutoffHour": 0,
      "weekendCutoffHour": 0
    },
    "shippingDays": [
      "FRIDAY"
    ],
    "to": "2022-10-17T22:48:36.908Z"
  },
  "address": {
    "addressType": "residential",
    "name": "Reno Address",
    "company": "Shipium",
    "street1": "123 Shipium Way",
    "street2": "Building 123",
    "city": "Reno",
    "state": "NV",
    "countryCode": "US",
    "postalCode": "89433"
  },
  "contact": {
    "email": "[email protected]",
    "name": "Reno Contact",
    "phoneNumber": "2223334444"
  },
  "description": "Reno Fulfillment Center",
  "href": "https://partner-management-service.stage.shipium.com/api/v1/partnerConfiguration/origins/5ddf6ced-eed2-4cec-bb7e-5cde30959843",
  "name": "Reno Fulfillment Center",
  "orchestratedAssetMetadata": {
    "orchestrationId": "4ad3b5d5-f256-4184-b9af-15ccca60ea99",
    "orchestrationTimeStamp": "2022-10-17T22:48:36.908Z"
  },
  "originId": "5ddf6ced-eed2-4cec-bb7e-5cde30959843",
  "originType": "at_large",
  "partnerId": "76abb3d4-8990-4f80-aa13-4c2007cb852a",
  "partnerProvidedId": "rno_fulfillment_center",
  "scheduleConfigured": true,
  "tenantLink": {
    "href": "https://partner-management-service.stage.shipium.com/api/v1/partnerConfiguration/origins/5ddf6ced-eed2-4cec-bb7e-5cde30959843",
    "tenantId": "f7092716-1b4b-4ce6-b4a6-e18b11f16c9d"
  }
}

Resources

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

Origin Configuration API

Get started

❗
Warning: potential negative impact on your fulfillment operations

Configure origins with the Origin Configuration API

📘
Authentication for API Calls

👉
How to use test mode

Create an origin

Path

Example cURL call

Example request body using street1 and street2

Example response body using street1 and street2

Example request body using addressLineComponents

Example response body using addressLineComponents

Retrieve a specific origin by ID

Path

Example request body

Example response body

Retrieve all origins

Path

Example request body

Example response body

Update an existing origin

Path

Example request body

Example response body

Delete an existing origin

Path

Example request body

Example response body

Resources

Get started

❗Warning: potential negative impact on your fulfillment operations

Configure origins with the Origin Configuration API

📘Authentication for API Calls

👉How to use test mode

Create an origin

Path

Example cURL call

Example request body using street1 and street2

Example response body using street1 and street2

Example request body using addressLineComponents

Example response body using addressLineComponents

Retrieve a specific origin by ID

Path

Example request body

Example response body

Retrieve all origins

Path

Example request body

Example response body

Update an existing origin

Path

Example request body

Example response body

Delete an existing origin

Path

Example request body

Example response body

Resources

❗
Warning: potential negative impact on your fulfillment operations

📘
Authentication for API Calls

👉
How to use test mode