Creates a new shipping configuration record that does not already exist.

Commerce

Creates a new shipping configuration record that does not already exist.

Request

This method will auto-generate an ID and create a new shipping configuration. If an ID is specified for the shipping configuration, an error will be thrown.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The shipping configuration that you would like to be saved.

default_ship_from_addressobject(Address)

A complete address

default_ship_from_namestring(Default Ship From Name)

The name of the shipper

default_shipping_product_idstring(Default Shipping Product)

The default shipping product id to use

notesstring(Notes)

Any notes about this configuration

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber, (float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring, (date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring, (date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber, (float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber, (float)(Sys Version)

A number representing the version of this record in the database

zonesArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/shippingConfigurations/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "default_ship_from_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "default_ship_from_name": "string",
    "default_shipping_product_id": "string",
    "notes": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "zones": [
      {
        "countries": [
          {
            "country": "string"
          }
        ],
        "enabled": true,
        "id": "string",
        "name": "string",
        "postal_code_ranges": [
          {
            "end": "string",
            "start": "string"
          }
        ],
        "pricing_strategies": {
          "flat_rate": {
            "enabled": true,
            "shipping_methods": [
              {
                "display_name": "string",
                "display_order": 0.1,
                "id": "string",
                "shipping_product_id": "string",
                "shipping_rate": 0.1,
                "type": "per item"
              }
            ],
            "shipping_product_id": "string"
          },
          "free": {
            "display_name": "string",
            "display_order": 0.1,
            "do_not_show_in_portal": true,
            "enabled": true,
            "id": "string",
            "maximum_order_amount": 0.1,
            "minimum_order_amount": 0.1,
            "shipping_product_id": "string"
          },
          "pick_up_in_store": {
            "cost": 0.1,
            "display_name": "string",
            "display_order": 0.1,
            "do_not_show_in_portal": true,
            "enabled": true,
            "id": "string",
            "shipping_product_id": "string"
          },
          "ship_by": {
            "enabled": true,
            "shipping_methods": [
              {
                "charge_shipping_by": "order total",
                "default_shipping_cost": 0.1,
                "display_name": "string",
                "display_order": 0.1,
                "id": "string",
                "ranges": [
                  {}
                ],
                "shipping_product_id": "string",
                "type": "fixed amount"
              }
            ],
            "shipping_product_id": "string"
          },
          "ups": {
            "display_order": 0.1,
            "do_not_show_in_portal": true,
            "enabled": true,
            "limit_shipping_options": true,
            "markup_amount": 0.1,
            "markup_type": "amount",
            "override_default_ship_from_address": true,
            "ship_from_address": {
              "city": "string",
              "country": "string",
              "country_name": "string",
              "county": "string",
              "latitude": 0.1,
              "line1": "string",
              "line2": "string",
              "line3": "string",
              "longitude": 0.1,
              "postal_code": "string",
              "state": "string",
              "time_zone_id": "string"
            },
            "shipping_options": [
              "string"
            ],
            "shipping_product_id": "string",
            "ups_account_id": "string"
          }
        },
        "shipping_product_id": "string",
        "states": [
          {
            "state": "string"
          }
        ],
        "type": "country"
      }
    ]
  }'

Responses

The shipping configuration was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json