CarrierService

examples

• Create a carrier service

  curl -d '{"carrier_service":{"name":"Shipping Rate Provider","callback_url":"http://shipping.example.com","service_discovery":true}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2025-07/carrier_services.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const carrier_service = new admin.rest.resources.CarrierService({session: session});
  
  carrier_service.name = "Shipping Rate Provider";
  carrier_service.callback_url = "http://shipping.example.com";
  carrier_service.service_discovery = true;
  await carrier_service.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  carrier_service = ShopifyAPI::CarrierService.new(session: test_session)
  carrier_service.name = "Shipping Rate Provider"
  carrier_service.callback_url = "http://shipping.example.com"
  carrier_service.service_discovery = true
  carrier_service.save!

  // Session is built by the OAuth process
  
  const carrier_service = new shopify.rest.CarrierService({session: session});
  carrier_service.name = "Shipping Rate Provider";
  carrier_service.callback_url = "http://shipping.example.com";
  carrier_service.service_discovery = true;
  await carrier_service.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"carrier_service":{"id":1036894959,"name":"Shipping Rate Provider","active":true,"service_discovery":true,"carrier_service_type":"api","admin_graphql_api_id":"gid://shopify/DeliveryCarrierService/1036894959","format":"json","callback_url":"http://shipping.example.com/"}}

examples

• Retrieve a list of carrier services

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/carrier_services.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.CarrierService.all({
    session: session,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::CarrierService.all(
    session: test_session,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.CarrierService.all({
    session: session,
  });

  response

  HTTP/1.1 200 OK{"carrier_services":[{"id":1036894957,"name":"Purolator","active":true,"service_discovery":true,"carrier_service_type":"api","admin_graphql_api_id":"gid://shopify/DeliveryCarrierService/1036894957","format":"json","callback_url":"http://example.com/"},{"id":260046840,"name":"ups_shipping","active":true,"service_discovery":true,"carrier_service_type":"legacy","admin_graphql_api_id":"gid://shopify/DeliveryCarrierService/260046840"}]}

examples

• Get a single carrier service by its ID

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/carrier_services/1036894954.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.CarrierService.find({
    session: session,
    id: 1036894954,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::CarrierService.find(
    session: test_session,
    id: 1036894954,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.CarrierService.find({
    session: session,
    id: 1036894954,
  });

  response

  HTTP/1.1 200 OK{"carrier_service":{"id":1036894954,"name":"Purolator","active":true,"service_discovery":true,"carrier_service_type":"api","admin_graphql_api_id":"gid://shopify/DeliveryCarrierService/1036894954","format":"json","callback_url":"http://example.com/"}}

examples

• Update a carrier service

  curl -d '{"carrier_service":{"id":1036894956,"name":"Some new name","active":false}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2025-07/carrier_services/1036894956.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const carrier_service = new admin.rest.resources.CarrierService({session: session});
  
  carrier_service.id = 1036894956;
  carrier_service.name = "Some new name";
  carrier_service.active = false;
  await carrier_service.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  carrier_service = ShopifyAPI::CarrierService.new(session: test_session)
  carrier_service.id = 1036894956
  carrier_service.name = "Some new name"
  carrier_service.active = false
  carrier_service.save!

  // Session is built by the OAuth process
  
  const carrier_service = new shopify.rest.CarrierService({session: session});
  carrier_service.id = 1036894956;
  carrier_service.name = "Some new name";
  carrier_service.active = false;
  await carrier_service.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"carrier_service":{"active":false,"id":1036894956,"name":"Some new name","service_discovery":true,"carrier_service_type":"api","admin_graphql_api_id":"gid://shopify/DeliveryCarrierService/1036894956","format":"json","callback_url":"http://example.com/"}}

examples

• Delete a carrier service

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2025-07/carrier_services/1036894955.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.CarrierService.delete({
    session: session,
    id: 1036894955,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::CarrierService.delete(
    session: test_session,
    id: 1036894955,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.CarrierService.delete({
    session: session,
    id: 1036894955,
  });

  response

  HTTP/1.1 200 OK{}