Orders - Revision history

Harv: /* Example Response */

2025-06-30T14:50:15Z

‎Example Response

Harv: /* Get Fulfillment Data */

2025-06-30T14:45:50Z

‎Get Fulfillment Data

Psu: /* Create an Order */

2023-06-14T20:10:59Z

‎Create an Order

Harv: /* Create Fulfillment Data */

2020-03-12T17:50:33Z

‎Create Fulfillment Data

Harv at 17:50, 12 March 2020

2020-03-12T17:50:19Z

Harv: /* Create an Order */

2020-02-12T19:17:57Z

‎Create an Order

Harv: /* Create an Order */

2020-02-12T19:17:19Z

‎Create an Order

Psu: /* Delete an Order */

2017-12-16T03:47:02Z

‎Delete an Order

Psu: /* Get all Orders */

2017-12-16T03:45:50Z

‎Get all Orders

Psu: /* Get an Order */

2017-12-16T03:44:24Z

‎Get an Order

@@ Line 419: / Line 419: @@
      "data": [
+         {
-             "partner": 760,
+             "partner": 43818,
-             "client": 74496,
+             "client": 3696250,
-             "order": 125550,
+             "order": 1639303,
-             "product": 2044,
+             "product": 4114,
-             "id": 255205,
+             "id": 10831066,
-             "directory": "Merchant Circle",
+             "price": 25,
-             "status": "temporary_problem",
+            "customPackage": null,
-             "comment": "Directory Unavailable at the Moment",
+            "priceMaintenance": 25,
-             "username": "project-125550@searchme.us",
+            "priceRenewal": null,
-             "password": "1LJBBoAY",
+            "delayMaintenance": 1,
-             "email": "project-125550@searchme.us",
+            "intervalMaintenance": "monthly",
-             "statusInitial": "not_present",
+             "intervalRenewal": "yearly",
-             "url": "about:version",
+             "periodMaintenance": 1,
-             "screenshotUrl": null,
+            "pendingRefresh": false,
-             "commentCustom": null,
+             "isDrip": "false",
-             "dateScreenshot": null,
+             "isDisabled": "false",
-             "recoveryPhone": null,
+             "isValid": "false",
-             "recoveryEmail": null,
+             "isCompleted": "false",
-             "fulfillmentUser": "import",
+             "createdAt": "2020-08-19T16:25:36.000Z",
-             "dateStarted": "2014-06-12T00:00:00.000Z",
+             "startedAt": null,
-             "dateEnded": "2014-06-12T00:00:00.000Z",
+             "completedAt": "0000-00-00 00:00:00",
-             "dateReplaced": null,
+            "disabledAt": null,
-             "dateCreated": "2014-06-12T00:00:00.000Z",
+             "derezzedAt": null,
-             "dateUrl": "2020-03-02T16:56:18.000Z",
+             "lastCheckedAt": null,
-             "dateUpdated": "2014-06-12T00:00:00.000Z",
+             "nextCheckAt": null
-             "dateVerified": null,
+        },
-             "type": "manual",
-             "isDisabled": false
+             "partner": 43818,
+         }
-    ],
+}
 </syntaxhighlight>
 == Get Fulfillment Data ==

@@ Line 391: / Line 391: @@
+         ]
+     }
+}
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
 == Create an Order ==
-You must [Trigger a Report] before creating orders. Ordering for a client consists of selecting what types of products (and sub products) are available and creating projects for the client. Once the order is in the database, then the payment can be initiated.  Orders can only be paid by providing an existing credit card ID.  The list of cards in the system can be retrieved using the cards which is documented here.  [[Partners]]
+Ordering for a client consists of selecting what types of products (and sub products) are available and creating projects for the client. Once the order is in the database, then the payment can be initiated.  Orders can only be paid by providing an existing credit card ID.  The list of cards in the system can be retrieved using the cards which is documented here.  [[Partners]]
 === API Endpoint ===

← Older revision		Revision as of 17:50, 12 March 2020
Line 395:		Line 395:


−	== ~~Create~~ Fulfillment Data ==	+	== Get Fulfillment Data ==
	Fulfillment data is all the data related to products in an order getting fulfilled. It includes information about the status of individual products, the live urls as a result of successful work, along with many other important dates, comments, and error messages.		Fulfillment data is all the data related to products in an order getting fulfilled. It includes information about the status of individual products, the live urls as a result of successful work, along with many other important dates, comments, and error messages.

← Older revision		Revision as of 17:50, 12 March 2020
Line 393:		Line 393:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
		+
		+
		+	== Create Fulfillment Data ==
		+	Fulfillment data is all the data related to products in an order getting fulfilled. It includes information about the status of individual products, the live urls as a result of successful work, along with many other important dates, comments, and error messages.
		+
		+	=== API Endpoint ===
		+	<syntaxhighlight lang="html">
		+	http://p.lssdev.com/legacyfulfillmentdata
		+	</syntaxhighlight>
		+
		+	=== Example Request ===
		+	<syntaxhighlight lang="php">
		+	POST /legacyorders?client=XXXXX HTTP/1.1
		+	Host: p.lssdev.com
		+	x-api-token: YOUR_API_KEY
		+	Content-Type: application/json
		+	</syntaxhighlight>
		+
		+	"client" is the unique identifier for the the location in our system (client_id from the Clients endpoints or GET /legacyclient/XXXX)
		+
		+	Any of the data returned can be filtered by
		+
		+	=== Example Response ===
		+	<syntaxhighlight lang="json">
		+	{
		+	"status": 200,
		+	"success": true,
		+	"error": null,
		+	"data": [
		+	{
		+	"partner": 760,
		+	"client": 74496,
		+	"order": 125550,
		+	"product": 2044,
		+	"id": 255205,
		+	"directory": "Merchant Circle",
		+	"status": "temporary_problem",
		+	"comment": "Directory Unavailable at the Moment",
		+	"username": "project-125550@searchme.us",
		+	"password": "1LJBBoAY",
		+	"email": "project-125550@searchme.us",
		+	"statusInitial": "not_present",
		+	"url": "about:version",
		+	"screenshotUrl": null,
		+	"commentCustom": null,
		+	"dateScreenshot": null,
		+	"recoveryPhone": null,
		+	"recoveryEmail": null,
		+	"fulfillmentUser": "import",
		+	"dateStarted": "2014-06-12T00:00:00.000Z",
		+	"dateEnded": "2014-06-12T00:00:00.000Z",
		+	"dateReplaced": null,
		+	"dateCreated": "2014-06-12T00:00:00.000Z",
		+	"dateUrl": "2020-03-02T16:56:18.000Z",
		+	"dateUpdated": "2014-06-12T00:00:00.000Z",
		+	"dateVerified": null,
		+	"type": "manual",
		+	"isDisabled": false
		+	}
		+	],
		+	"total": 10736
		+	}
		+	</syntaxhighlight>
		+
		+	Here is a description of some of the most useful fields
		+
		+	* directory - the local directory or source that we are publishing to
		+	* comment - a comment left by our team or response directly from an API
		+	* username/password - any login information associated with the listing that may have been used or created
		+	* email - email address possibly associated with account creation, NOT necessarily the business's email
		+	* url - the live url of the listing
		+	* dateCreated - the date the listing and data was initialized
		+	* dateUrl - the date we first see a url (supported API version 4.15, Feb 2020 onward)
		+	* dateUpdated - date it was last updated/modified/touched
		+	* type - either manual or api

@@ Line 15: / Line 15: @@
-{"client":3201926,"products":[3021,3047,3063,3230]}
+{"client":3201926,"products":[3021,3047,3063,3230], "card_id": "CREDIT_CARD_ID_HERE"}
 </syntaxhighlight>
 "client" is the unique client identifier (client_id) of the client.

@@ Line 252: / Line 252: @@
 == Delete an Order ==
 === API Endpoint ===
 <syntaxhighlight lang="html">