• getGet all revisions
• getGet revision by id
• putPut revision by id

API docs by Redocly

Fulfillment config history API (v0)

Download OpenAPI specification:Download

Team Routing: team-routing@newstore.com

Information on historical fulfillment configuration data

Get all revisions

This endpoint can be used to get all revisions of the fulfillment config for the given tenant

Authorizations:

newStoreAccessToken

Responses

/v0/fulfillment_configuration/revisions

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "revision": 3,
  • "version": 2,
  • "created_at": "2023-05-12T19:13:17.068239Z",
  • "url": "v0/fulfillment_configuration/revision/3"

  },
• {

  • "revision": 2,
  • "version": 2,
  • "created_at": "2023-05-12T19:12:57.258273Z",
  • "url": "v0/fulfillment_configuration/revision/2"

  },
• {

  • "revision": 1,
  • "version": 2,
  • "created_at": "2023-05-12T19:12:42.238199Z",
  • "url": "v0/fulfillment_configuration/revision/1"

  }

]

Get revision by id

This endpoint can be used to get a revision (with body) of the fulfillment config for the given tenant

Authorizations:

newStoreAccessToken

path Parameters

id required

string ID of the revision to retrieve

Responses

/v0/fulfillment_configuration/revision/{id}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "revision": 2,
• "fulfillment_config": {

  • "routes": [

    • {

      • "fulfilled_by": {

        • "SAME_DAY_DELIVERY": [

          • {

            • "provider_rate": "UPS_SAME_DAY_RATE",
            • "fulfillment_node_id": "store1_NYC"

            }

          ]

        },
      • "destination_region": {

        • "countries": [

          • "US"

          ],
        • "zip_codes": [

          • "10*"

          ]

        }

      },
    • {

      • "fulfilled_by": {

        • "TRADITIONAL": [

          • {

            • "provider_rate": "UPS_TRADITIONAL_RATE",
            • "fulfillment_node_id": "DC01"

            }

          ]

        },
      • "destination_region": {

        • "countries": [

          • "US"

          ],
        • "zip_codes": [

          • "*"

          ]

        }

      }

    ],
  • "provider_rates": {

    • "UPS_SAME_DAY_RATE": {

      • "service_level": "SAME_DAY_DELIVERY",
      • "shipping_type": "same_day_delivery",
      • "return_provider_rate": "",
      • "shipping_carrier_name": "UPS",
      • "use_as_customer_facing_cost": false,
      • "carrier_defined_service_level": "ExpressPlus"

      },
    • "FEDEX_SAME_DAY_RATE": {

      • "service_level": "SAME_DAY_DELIVERY",
      • "shipping_type": "same_day_delivery",
      • "return_provider_rate": "",
      • "shipping_carrier_name": "FedEx",
      • "use_as_customer_facing_cost": false,
      • "carrier_defined_service_level": "PriorityService"

      },
    • "UPS_TRADITIONAL_RATE": {

      • "service_level": "TRADITIONAL",
      • "shipping_type": "same_day_delivery",
      • "return_provider_rate": "",
      • "shipping_carrier_name": "UPS",
      • "use_as_customer_facing_cost": false,
      • "carrier_defined_service_level": "Ground"

      },
    • "FEDEX_TRADITIONAL_RATE": {

      • "service_level": "TRADITIONAL",
      • "shipping_type": "same_day_delivery",
      • "return_provider_rate": "",
      • "shipping_carrier_name": "FEDEX",
      • "use_as_customer_facing_cost": false,
      • "carrier_defined_service_level": "FEDEX_GROUND"

      },
    • "USPS_TRADITIONAL_RATE": {

      • "service_level": "TRADITIONAL",
      • "shipping_type": "same_day_delivery",
      • "return_provider_rate": "",
      • "shipping_carrier_name": "USPS",
      • "use_as_customer_facing_cost": false,
      • "carrier_defined_service_level": "First"

      }

    },
  • "service_levels": {

    • "SAME_DAY_DELIVERY": {

      • "price": 15,
      • "tax_code": "",
      • "display_name": "Same day delivery",
      • "currency_code": "USD",
      • "delivery_time": "Today, if order is placed by 2 pm.",
      • "remorse_period": 120,
      • "delivery_time_after_cutoff_hour": "Tomorrow"

      },
    • "TRADITIONAL": {

      • "price": 0,
      • "tax_code": "",
      • "display_name": "Traditional delivery",
      • "currency_code": "USD",
      • "delivery_time": "3-7 business days",
      • "delivery_time_after_cutoff_hour": "4-8 business days"

      }

    },
  • "sl_levels_priority": [

    • "SAME_DAY_DELIVERY",
    • "TRADITIONAL"

    ],
  • "provider_rates_priority": {

    • "*": {

      • "*": {

        • "SAME_DAY_DELIVERY": [

          • "UPS_SAME_DAY_RATE",
          • "FEDEX_SAME_DAY_RATE"

          ],
        • "TRADITIONAL": [

          • "UPS_TRADITIONAL_RATE",
          • "FEDEX_TRADITIONAL_RATE",
          • "USPS_TRADITIONAL_RATE"

          ]

        }

      },
    • "US": {

      • "*": {

        • "SAME_DAY_DELIVERY": [

          • "FEDEX_SAME_DAY_RATE",
          • "UPS_SAME_DAY_RATE"

          ],
        • "TRADITIONAL": [

          • "FEDEX_TRADITIONAL_RATE",
          • "UPS_TRADITIONAL_RATE",
          • "USPS_TRADITIONAL_RATE"

          ]

        },
      • "DC01": {

        • "SAME_DAY_DELIVERY": [

          • "UPS_SAME_DAY_RATE",
          • "FEDEX_SAME_DAY_RATE"

          ],
        • "TRADITIONAL": [

          • "USPS_TRADITIONAL_RATE",
          • "UPS_TRADITIONAL_RATE",
          • "FEDEX_TRADITIONAL_RATE"

          ]

        }

      }

    }

  },
• "updated_by": "user1",
• "created_at": "2023-05-12T19:12:57.258273Z",
• "tenant": "dodici"

}

Put revision by id

This endpoint can be used to set any previous revision of the fulfillment configuration

Authorizations:

newStoreAccessToken

path Parameters

id required

string ID of the revision to set

Responses

/v0/fulfillment_configuration/revision/{id}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "revision": 2,
• "fulfillment_config": {

  • "routes": [

    • {

      • "fulfilled_by": {

        • "SAME_DAY_DELIVERY": [

          • {

            • "provider_rate": "UPS_SAME_DAY_RATE",
            • "fulfillment_node_id": "store1_NYC"

            }

          ]

        },
      • "destination_region": {

        • "countries": [

          • "US"

          ],
        • "zip_codes": [

          • "10*"

          ]

        }

      },
    • {

      • "fulfilled_by": {

        • "TRADITIONAL": [

          • {

            • "provider_rate": "UPS_TRADITIONAL_RATE",
            • "fulfillment_node_id": "DC01"

            }

          ]

        },
      • "destination_region": {

        • "countries": [

          • "US"

          ],
        • "zip_codes": [

          • "*"

          ]

        }

      }

    ],
  • "provider_rates": {

    • "UPS_SAME_DAY_RATE": {

      • "service_level": "SAME_DAY_DELIVERY",
      • "shipping_type": "same_day_delivery",
      • "return_provider_rate": "",
      • "shipping_carrier_name": "UPS",
      • "use_as_customer_facing_cost": false,
      • "carrier_defined_service_level": "ExpressPlus"

      },
    • "FEDEX_SAME_DAY_RATE": {

      • "service_level": "SAME_DAY_DELIVERY",
      • "shipping_type": "same_day_delivery",
      • "return_provider_rate": "",
      • "shipping_carrier_name": "FedEx",
      • "use_as_customer_facing_cost": false,
      • "carrier_defined_service_level": "PriorityService"

      },
    • "UPS_TRADITIONAL_RATE": {

      • "service_level": "TRADITIONAL",
      • "shipping_type": "same_day_delivery",
      • "return_provider_rate": "",
      • "shipping_carrier_name": "UPS",
      • "use_as_customer_facing_cost": false,
      • "carrier_defined_service_level": "Ground"

      },
    • "FEDEX_TRADITIONAL_RATE": {

      • "service_level": "TRADITIONAL",
      • "shipping_type": "same_day_delivery",
      • "return_provider_rate": "",
      • "shipping_carrier_name": "FEDEX",
      • "use_as_customer_facing_cost": false,
      • "carrier_defined_service_level": "FEDEX_GROUND"

      },
    • "USPS_TRADITIONAL_RATE": {

      • "service_level": "TRADITIONAL",
      • "shipping_type": "same_day_delivery",
      • "return_provider_rate": "",
      • "shipping_carrier_name": "USPS",
      • "use_as_customer_facing_cost": false,
      • "carrier_defined_service_level": "First"

      }

    },
  • "service_levels": {

    • "SAME_DAY_DELIVERY": {

      • "price": 15,
      • "tax_code": "",
      • "display_name": "Same day delivery",
      • "currency_code": "USD",
      • "delivery_time": "Today, if order is placed by 2 pm.",
      • "remorse_period": 120,
      • "delivery_time_after_cutoff_hour": "Tomorrow"

      },
    • "TRADITIONAL": {

      • "price": 0,
      • "tax_code": "",
      • "display_name": "Traditional delivery",
      • "currency_code": "USD",
      • "delivery_time": "3-7 business days",
      • "delivery_time_after_cutoff_hour": "4-8 business days"

      }

    },
  • "sl_levels_priority": [

    • "SAME_DAY_DELIVERY",
    • "TRADITIONAL"

    ],
  • "provider_rates_priority": {

    • "*": {

      • "*": {

        • "SAME_DAY_DELIVERY": [

          • "UPS_SAME_DAY_RATE",
          • "FEDEX_SAME_DAY_RATE"

          ],
        • "TRADITIONAL": [

          • "UPS_TRADITIONAL_RATE",
          • "FEDEX_TRADITIONAL_RATE",
          • "USPS_TRADITIONAL_RATE"

          ]

        }

      },
    • "US": {

      • "*": {

        • "SAME_DAY_DELIVERY": [

          • "FEDEX_SAME_DAY_RATE",
          • "UPS_SAME_DAY_RATE"

          ],
        • "TRADITIONAL": [

          • "FEDEX_TRADITIONAL_RATE",
          • "UPS_TRADITIONAL_RATE",
          • "USPS_TRADITIONAL_RATE"

          ]

        },
      • "DC01": {

        • "SAME_DAY_DELIVERY": [

          • "UPS_SAME_DAY_RATE",
          • "FEDEX_SAME_DAY_RATE"

          ],
        • "TRADITIONAL": [

          • "USPS_TRADITIONAL_RATE",
          • "UPS_TRADITIONAL_RATE",
          • "FEDEX_TRADITIONAL_RATE"

          ]

        }

      }

    }

  },
• "updated_by": "user1",
• "created_at": "2023-05-12T19:12:57.258273Z",
• "tenant": "dodici"

}