Anmelden

nShift Help Center

Agenten

Avatar
Malene Tidemann
Aktualisiert

Delivery-checkout-label.png


Erstellt und aktiviert benutzerdefinierte Agentenlisten.


Abschnitte in diesem Artikel:

 

Eine Agentenliste erstellen

POST /agents

Erstellt eine benutzerdefinierte Agentenliste basierend auf Geolokalisierung oder Postleitzahlenbereich.

  • Wenn die Agentenliste sofort aktiviert werden soll, muss activate auf true gesetzt werden.
     
  • type muss für Geolokalisierung auf normal und für Postleitzahlenbereich auf zipcode gesetzt werden.
     
  • Bei normal sind mapLongitude und mapLatitude erforderlich.
     
  • Bei zipcode ist ein agentZipcodes-Array für jeden Agenten erforderlich.
     
  • countryCode ist immer erforderlich.
     

 

Body-Beispiel – Geolokalisierung

{
  "key": "listkey",
  "activate": "true",
  "type": "normal",
  "countryCode": "SE",
  "agents": [
    {
      "id": "1",
      "name": "Agent name 1",
      "address1": "Test gatan 1",
      "address2": "",
      "zipcode": "41118",
      "city": "Göteborg",
      "state": "",
      "countryCode": "SE",
      "mapLongitude": "22.2",
      "mapLatitude": "-11.1",
      "phone": "07443332211",
      "email": "test@test.com",
      "additionalInfo": "Additional information",
      "flags": [
        "express",
        "hem"
      ],
      "openingHourWeekdays": [
        {
          "weekday": "monday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "tuesday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "wednesday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "thursday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "friday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "saturday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "sunday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        }
      ],
      "openingHourSpecialDays": [
        {
          "date": "2018-04-27",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2018-04-28",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2018-10-10",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        }
      ]
    },
    {
      "id": "2",
      "name": "Agent name 2",
      "address1": "Testvägen 10",
      "address2": "",
      "zipcode": "11359",
      "city": "Stockholm",
      "state": "",
      "countryCode": "SE",
      "mapLongitude": "33.3",
      "mapLatitude": "17.4",
      "phone": "0700331122",
      "email": "test2@test2.com",
      "additionalInfo": "Additional information",
      "flags": [
        "hem"
      ],
      "openingHourWeekdays": [
        {
          "weekday": "monday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "tuesday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "wednesday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "thursday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "friday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "saturday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "sunday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        }
      ],
      "openingHourSpecialDays": [
        {
          "date": "2020-12-24",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2020-12-25",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2020-12-26",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        }
      ]
    }
  ]
}

 

Body-Beispiel – Postleitzahl

{
  "key": "listkey",
  "activate": "true",
  "type": "zipcode",
  "countryCode": "SE",
  "agents": [
    {
      "id": "1",
      "name": "Agent name 1",
      "address1": "Test gatan 1",
      "address2": "",
      "zipcode": "41118",
      "city": "Göteborg",
      "state": "",
      "country": "SE",
      "phone": "07443332211",
      "email": "test@test.com",
      "additionalInfo": "Additional information",
      "flags": [
        "express",
        "hem"
      ],
      "agentZipcodes": [
        {
          "from": "40000",
          "to": "45000"
        },
        {
          "from": "46000",
          "to": ""
        }
      ],
      "openingHourWeekdays": [
        {
          "weekday": "monday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "tuesday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "wednesday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "thursday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "friday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "saturday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "sunday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        }
      ],
      "openingHourSpecialDays": [
        {
          "date": "2018-04-27",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2018-04-28",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2018-10-10",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        }
      ]
    }
  ]
}

 

Antwortbeispiel

{
  "id": "11111"
}

Eine Beschreibung der Eigenschaften finden Sie im Eigenschaftsreferenzhandbuch.

Für Schema und Tests verweisen wir auf https://api.unifaun.com/rs-docs/; navigieren Sie zu /agents POST.

 

 

Agentenlisten abrufen

GET /agents

Ruft alle benutzerdefinierten Agentenlisten der Delivery Checkout-Konfiguration ab.

 

Antwortbeispiel

[
  {
    "id": "11111",
    "name": "listkey",
    "active": true,
    "status": "OK",
    "created": "2021-05-19T14:08:00.179+0000"
  }
]

Eine Beschreibung der Eigenschaften finden Sie im Eigenschaftsreferenzhandbuch.

Für Schema und Tests verweisen wir auf https://api.unifaun.com/rs-docs/; navigieren Sie zu /agents GET.

 

 

Eine Agentenliste aktivieren

POST /agents/{id}

Aktiviert eine benutzerdefinierte Agentenliste.

 

URI-Parameter

Agent list id string Identifikation der Agentenliste Erforderlich

 

Es wird kein Antworttext zurückgegeben, wenn eine Agentenliste erfolgreich aktiviert wurde.

Eine Beschreibung der Eigenschaften finden Sie im Eigenschaftsreferenzhandbuch.

Für Schema und Tests verweisen wir auf https://api.unifaun.com/rs-docs/; navigieren Sie zu /agents/{id} POST.

 

 

Eine Agentenliste löschen

DELETE /agents/{id}

Löscht eine Agentenliste.

 

URI-Parameter

Agent list id string Identifikation der Agentenliste Erforderlich


Es wird kein Antworttext zurückgegeben, wenn eine Agentenliste erfolgreich gelöscht wurde.

Eine Beschreibung der Eigenschaften finden Sie im Eigenschaftsreferenzhandbuch.

Für Schema und Tests verweisen wir auf https://api.unifaun.com/rs-docs/; navigieren Sie zu

/agents/{id} DELETE.

Verwandte Beiträge