/shipping_integrations

Create

Stores e-Courier credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (EcourierCredsClientCreate1) -> (PydanticObjectId)

post/shipping_integrations/ecourier/creds/v1/{provider_org_id}

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/shipping_integrations/ecourier/creds/v1/{provider_org_id}
  • Auth
    HTTP bearer

Path parameters

provider_org_idstring required

Must be a string starting with org_

Request body

schema_version1 required
base_urlstring required

Origin of the courier's e-Courier host, with no path. The request path is derived from ecourier_database.

ecourier_databasestring required
usernamestring required
passwordstring required
ecourier_customer_codestring required
ecourier_customer_idstring required
notesstring nullable

Example request

{
  "base_url": "https://bigtex.e-courier.com"
}

Response

Successful Response

string required

Changes

No recorded changes to this operation across all 20 revisions of this API.