POST:shipping_providers.json

Description

Create one or multiple shipping providers.

Permission bit: "shipping_providers.create"

Topic: Shipping Providers

Query Parameters

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Request Body

Array of ShippingProviderCreate

Copy
[
  {
    "auspost_options": {
      "auth_key": ""
    },
    "canadapost_options": {
      "contract_id": "",
      "customer_number": "",
      "password": "",
      "user_id": ""
    },
    "currency": "USD",
    "delivery_date_guaranteed": true,
    "delivery_days_max": 5,
    "delivery_days_min": 2,
    "description": "TODO",
    "fedex_options": {
      "account_number": "",
      "key": "",
      "meter_number": "",
      "password": ""
    },
    "lead_time_hours_max": 5,
    "lead_time_hours_min": 2,
    "name": "Fixed 20$",
    "rate": 2000,
    "surcharge_fixed": 500,
    "surcharge_percentage": 1,
    "test": false,
    "tracking": true,
    "type": "auspost",
    "ups_options": {
      "access_license_number": "",
      "account_number": "",
      "imperial": true,
      "negotiated_rates": true,
      "password": "",
      "pickup_type": "",
      "user_id": ""
    },
    "usps_options": {
      "container": "",
      "service": "",
      "user_id": ""
    },
    "whitelist": [
      {
        "service_code_pattern": "aus_parcel_regular",
        "service_name_pattern": "Domestic Express Post"
      }
    ]
  }
]

Response Body

Array of ShippingProvider

Response Body Type

Loading module